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

SubscribeRequest

data class SubscribeRequest(account: String) : SignaldRequestBodyV1<SubscriptionResponse>

receive incoming messages. After making a subscribe request, incoming messages will be sent to the client encoded as ClientMessageWrapper. Send an unsubscribe request or disconnect from the socket to stop receiving messages.

Constructors

SubscribeRequest

fun SubscribeRequest(account: String)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): SubscriptionResponse

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

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): SubscriptionResponse

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

Properties

account

val account: String

The account to subscribe to incoming message for

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