Subscription

class Subscription : IncomingMessageSubscription
class Subscription : IncomingMessageSubscription

Contains information about an active incoming message subscription with signald.

Functions

close
Link copied to clipboard
common
open override fun close()
nextMessage
Link copied to clipboard
open override fun nextMessage(): <ERROR CLASS>?
abstract fun nextMessage(): ClientMessageWrapper?
synchronousClient
open override fun nextMessage(): ClientMessageWrapper?
Parses an incoming message from the socket.
nextMessageSuspend
Link copied to clipboard
js
open suspend override fun nextMessageSuspend(): <ERROR CLASS>?
Parses an incoming message from the socket.
open suspend override fun nextMessageSuspend(): ClientMessageWrapper?
abstract suspend fun nextMessageSuspend(): ClientMessageWrapper?
unsubscribe
Link copied to clipboard
suspend fun unsubscribe(): <ERROR CLASS>
fun unsubscribe(): SubscriptionResponse

Properties

accountId
Link copied to clipboard
val accountId: String
initialMessagesCount
Link copied to clipboard
common
abstract val initialMessagesCount: Int
The number of messages sent while we were waiting for signald's response to the subscribe request.
initialMessagesCount
Link copied to clipboard
js
open override val initialMessagesCount: Int
The number of messages sent while we were waiting for signald's response to the subscribe.
initialMessagesCount
Link copied to clipboard
synchronousClient
open override val initialMessagesCount: Int
The number of messages sent while we were waiting for signald's response to the subscribe.