SubscribeRequest

data class SubscribeRequest(account: String) : SignaldRequestBodyV1<Subscribe, 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

common

fun SubscribeRequest(account: String)

Functions

getTypedResponseOrNull

common

open override fun getTypedResponseOrNull(responseWrapper: JsonMessageWrapper<*>): SubscriptionResponse?

A function to resolve the response body by verifying the type of the response and returning a non-null value iff the wrapper and data is the right type.

submit

common

fun submit(socketCommunicator: SocketCommunicator): SubscriptionResponse

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

Marked as internal so tests can access.

Properties

account

common

val account: String

The account to subscribe to incoming message for Example: "+12024561414"

common

val id: String

The id to include in the request.

version

common

val version: String

The version to include in the request.