PresenceChannel class

Inheritance
Annotations
  • @JS()

Constructors

PresenceChannel(String name, Pusher pusher)
Adds presence channel functionality to private channels.
factory

Properties

callbacks CallbackRegistry
getter/setter pairinherited
failThrough Function
getter/setter pairinherited
global_callbacks List<Function>
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
members Members
getter/setter pair
name String
getter/setter pairinherited
pusher Pusher
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
subscribed bool
getter/setter pairinherited
subscriptionCancelled bool
getter/setter pairinherited
subscriptionPending bool
getter/setter pairinherited

Methods

authorize(String socketId, Function callback) → dynamic
Authenticates the connection as a member of the channel.
override
bind(String eventName, Function callback, [dynamic context]) → dynamic
inherited
bind_global(Function callback) → dynamic
inherited
cancelSubscription() → dynamic
Cancels an in progress subscription. For internal use only.
inherited
disconnect() → dynamic
Resets the channel state, including members map. For internal use only.
override
emit(String eventName, [dynamic data, Metadata metadata]) Dispatcher
inherited
handleEvent(PusherEvent event) → dynamic
Handles presence and subscription events. For internal use only.
override
handleInternalEvent(PusherEvent event) → dynamic
handleSubscriptionSucceededEvent(PusherEvent event) → dynamic
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reinstateSubscription() → dynamic
Reinstates an in progress subscripiton. For internal use only.
inherited
subscribe() → dynamic
Sends a subscription request. For internal use only.
inherited
toString() String
A string representation of this object.
inherited
trigger(String event, dynamic data) → dynamic
Triggers an event
inherited
unbind([String eventName, Function callback, dynamic context]) → dynamic
inherited
unbind_all() → dynamic
inherited
unbind_global([Function callback]) → dynamic
inherited
unsubscribe() → dynamic
Sends an unsubscription request. For internal use only.
inherited

Operators

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