HotlineSubscription class

A subscription instance for handling channel-specific messages


HotlineSubscription(String identifier, HotlineSubscriptionManager subscriptionManager, {required Function? onReceived, required Function? onConfirmed, Function? onUnsubscribed, Function? onRejected})


cancelledBySubscriptionManager bool
no getter
hashCode int
The hash code for this object.
no setterinherited
identifier String
getter/setter pair
onConfirmed Function?
getter/setter pair
onReceived Function?
optional subscription callbacks
getter/setter pair
onRejected Function?
getter/setter pair
onUnsubscribed Function?
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
state HotlineSubscriptionRequestState
getter/setter pair
stateType HotlineSubscriptionRequestState
set the state of this subscription
no getter
status Stream<HotlineSubscriptionRequestState>
anything listening for updates to the subscription request...
no setter
stream Stream<Map>
this dispatch the data we receive onto the stream listeners...
no setter
subscriptionManager HotlineSubscriptionManager
getter/setter pair


confirmed() → void
called by the Hotline connection dispatcher
handleResponse(Map payload) → void
determine how to handle this response and call the relevant handler...
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
perform(String action, [Map<String, dynamic>? params]) → void
send a message to a WebSocket channel on the server to its corresponding channel action
rejected() → void
the subscription request was not granted
suspend() → void
temporarily stop receiving data on this subscription instance
toString() String
A string representation of this object.
unsubscribe() → void
stop receiving messages for this channel


operator ==(Object other) bool
The equality operator.