Subscription class

Represents a subscription to a set of channels and channel groups.

Immutable. Can be paused and resumed multiple times. After cancel is called, the subscription cannot be used again.

Constructors

Subscription(Manager _manager, Set<String>? _channels, Set<String>? _channelGroups, bool? _withPresence)

channelGroups → Set<String>: Set of channel groups that this subscription represents.
no setter
channels → Set<String>: Set of channels that this subscription represents.
no setter
hashCode → int: The hash code for this object.
no setterinherited
isCancelled → bool: Whether this subscription has been cancelled.
no setter
isPaused → bool: Whether this subscription is currently paused.
no setter
keyset → Keyset: Keyset that this subscription is using.
no setter
messages → Stream<Envelope>: Broadcast stream of messages in this subscription.
no setter
presence → Stream<PresenceEvent>: Broadcast stream of presence events.
no setter
presenceChannelGroups → Set<String>: Set of presence channel groups that are generated from set of channel groups
no setter
presenceChannels → Set<String>: Set of presence channels that are generated from set of channels
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
whenStarts → Future<void>: Completes when a subscription actually starts listening for messages.
no setter
withPresence → bool: Whether this subscription receives presence events.
no setter

cancel() → Future<void>: Cancels the subscription.
dispose() → Future<void>: Alias for cancel.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
pause() → void: Pause subscription.
restore() → Future<void>: Restores the subscription and its shared, underlying subscribe loop after an exception.
resume() → void: Resume currently paused subscription.
subscribe() → void: Alias for resume.
toString() → String: A string representation of this object.
inherited
unsubscribe() → void: Alias for pause.