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

RemoteDeleteRequest

data class RemoteDeleteRequest(account: String, address: JsonAddress?, group: String?, timestamp: Long, members: List<JsonAddress>?) : SignaldRequestBodyV1<SendResponse>

delete a message previously sent

Constructors

RemoteDeleteRequest

fun RemoteDeleteRequest(account: String, address: JsonAddress? = null, group: String? = null, timestamp: Long, members: List<JsonAddress>? = null)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): SendResponse

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

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): SendResponse

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

Properties

account

val account: String

the account to use

address

val address: JsonAddress? = null

the address to send the delete message to. should match address the message to be deleted was sent to. required if group is not set.

group

val group: String? = null

the group to send the delete message to. should match group the message to be deleted was sent to. required if address is not set.

val id: String

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

members

val members: List<JsonAddress>? = null

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

timestamp

val timestamp: Long

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