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

SendSyncMessageRequest

data class SendSyncMessageRequest(account: String, viewOnceOpenMessage: JsonViewOnceOpenMessage?, messageRequestResponse: JsonMessageRequestResponseMessage?) : SignaldRequestBodyV1<JsonSendMessageResult>

Sends a sync message to the account's devices

Constructors

fun SendSyncMessageRequest(account: String, viewOnceOpenMessage: JsonViewOnceOpenMessage? = null, messageRequestResponse: JsonMessageRequestResponseMessage? = null)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): JsonSendMessageResult

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

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): JsonSendMessageResult

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

Properties

account

val account: String

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

val id: String

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

messageRequestResponse

val messageRequestResponse: JsonMessageRequestResponseMessage? = null

This can be set to indicate to other devices about a response to an incoming message request from an unknown user or group. Warning: Using the BLOCK and BLOCK_AND_DELETE options relies on other devices to do the blocking, and it does not make you leave the group!

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

viewOnceOpenMessage

val viewOnceOpenMessage: JsonViewOnceOpenMessage? = null

This can be set to indicate to other devices about having viewed a view-once message.