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

SendRequest

data class SendRequest(username: String?, account: String?, recipientAddress: JsonAddress?, recipientGroupId: String?, messageBody: String?, attachments: List<JsonAttachment>?, quote: JsonQuote?, timestamp: Long?, mentions: List<JsonMention>?, previews: List<JsonPreview>?, members: List<JsonAddress>?, isForStory: Boolean?) : SignaldRequestBodyV1<SendResponse>

Functions

fun submit(socketCommunicator: SocketCommunicator): SendResponse

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

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): SendResponse

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

Properties

val account: String? = null

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

val attachments: List<JsonAttachment>? = null

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

val isForStory: Boolean? = null

set to true when replying to a story

val members: List<JsonAddress>? = null

Optionally set to a sub-set of group members. Ignored if recipientGroupId isn't specified

val mentions: List<JsonMention>? = null

val messageBody: String? = null

Example: "hello"

val previews: List<JsonPreview>? = null

val quote: JsonQuote? = null

recipientAddress

val recipientAddress: JsonAddress? = null

recipientGroupId

val recipientGroupId: String? = null

Example: "EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE="

val timestamp: Long? = null

val username: String? = null

Example: "+12024561414"

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