Channel class

Provides base public channel interface with an event emitter. Emits:

  • pusher:subscription_succeeded - after subscribing successfully
  • other non-internal events
Inheritance
Implementers
Annotations
  • @JS()

Constructors

Channel(String name, Pusher pusher)
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
name String
getter/setter pair
pusher Pusher
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
subscribed bool
getter/setter pair
subscriptionCancelled bool
getter/setter pair
subscriptionPending bool
getter/setter pair

Methods

authorize(String socketId, AuthorizerCallback callback) → dynamic
Skips authorization, since public channels don't require it.
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.
disconnect() → dynamic
Signals disconnection to the channel. For internal use only.
emit(String eventName, [dynamic data, Metadata metadata]) Dispatcher
inherited
handleEvent(PusherEvent event) → dynamic
Handles a PusherEvent. For internal use only.
handleSubscriptionSucceededEvent(PusherEvent event) → dynamic
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.
subscribe() → dynamic
Sends a subscription request. For internal use only.
toString() String
A string representation of this object.
inherited
trigger(String event, dynamic data) → dynamic
Triggers an event
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.

Operators

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