PresenceChannel class

Represents a presence channel in Pusher.

Inheritance

Constructors

PresenceChannel.new({required PusherClient client, required String name})

Properties

authData AuthData?
getter/setter pairinherited
authOptions PusherAuthOptions
The authentication options of the client.
no setterinherited
client PusherClient
The pusher client.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
isEncrypted bool
no setterinherited
isPresence bool
no setterinherited
isPrivate bool
no setterinherited
isPublic bool
no setterinherited
member Member?
The user member of the channel.
no setteroverride
members List<Member>
no setter
name String
The name of the channel.
finalinherited
options PusherOptions
The options of the client.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
subscribed bool
Whether the channel is subscribed or not.
getter/setter pairinherited
subscriptionCount int
The number of subscriptions to the channel.
no setterinherited
userId String?
getter/setter pairinherited

Methods

bind(String event, Function listener) → void
Binds a listener to an event.
inherited
handleEvent(String event, dynamic data) → void
Handles an event.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onMemberAdded(Function callback) → void
Binding for the member added event.
onMemberRemoved(Function callback) → void
Binding for the member removed event.
onSubscriptionCount(Function listener) → void
Binding for the subscription count event.
inherited
onSubscriptionSuccess(Function listener) → void
Binding for the subscription success event.
inherited
subscribe([bool force = false]) → void
Subscribes to the private channel.
inherited
toString() String
A string representation of this object.
inherited
trigger(String event, [dynamic data]) → void
Send an event to the channel.
inherited
unbind(String event) → void
Unbinds a listener from an event.
inherited
unsubscribe() → void
Unsubscribes from the channel.
inherited

Operators

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