clientprotocol/org.inthewaves.kotlinsignald.clientprotocol.v1.structures/ListContactsRequest

ListContactsRequest

data class ListContactsRequest(account: String, async: Boolean?) : SignaldRequestBodyV1<ProfileList>

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): ProfileList

open override fun submit(socketCommunicator: SocketCommunicator, id: String): ProfileList

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): ProfileList

open suspend override fun submitSuspend(socketCommunicator: SuspendSocketCommunicator, id: String): ProfileList

Properties

account

val account: String

Example: "0cc10e61-d64c-4dbc-b51c-334f7dd45a4a"

async

val async: Boolean? = null

return results from local store immediately, refreshing from server afterward if needed. If false (default), block until all pending profiles have been retrieved.

val id: String

The id to include in the request. This is expected to be present in the response JSON.

version

val version: String

The version to include in the request. As this class won't be used to deserialize the response, the Required annotation is being used to force this field to be serialized