SocketIoPresenceChannel class
This class represents a Socket.io presence channel.
- Inheritance
-
- Object
- Channel
- SocketIoChannel
- SocketIoPrivateChannel
- SocketIoPresenceChannel
- Implemented types
Constructors
- SocketIoPresenceChannel(Socket socket, String name, SocketIoConnectorOptions options)
Properties
- authData → AuthData?
-
no setterinherited
-
events
→ Map<
String, dynamic> -
The event callbacks applied to the socket.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
listeners
→ Map<
String, List> -
User supplied callbacks for events on this channel
finalinherited
- name → String
-
The name of the channel.
finalinherited
- options → ConnectorOptions
-
The Echo options.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- socket → Socket
-
The Socket.io client instance.
finalinherited
Methods
-
error(
Function callback) → void -
Register a callback to be called anytime an error occurs.
inherited
-
eventHandler(
String event, dynamic data) → Map -
inherited
-
here(
Function callback) → void -
Register a callback to be called anytime the member list changes.
override
-
joining(
Function callback) → void -
Listen for someone joining the channel.
override
-
leaving(
Function callback) → void -
Listen for someone leaving the channel.
override
-
listen(
String event, Function callback) → void -
Listen for an event on the channel instance.
inherited
-
listenForWhisper(
String event, Function callback) → void -
Listen for a whisper event on the channel instance.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notification(
Function callback) → void -
Listen for an event on the channel instance.
inherited
-
on(
String event, Function callback) → void -
Bind the channel's socket to an event and store the callback.
inherited
-
onSubscribedCount(
Function callback) → void -
listen to on subscribe count event
override
-
onSubscribedSuccess(
Function callback) → void -
listen to on subscribe success event
inherited
-
stopListening(
String event, [Function? callback]) → void -
Stop listening for an event on the channel instance.
inherited
-
stopListeningForWhisper(
String event, [Function? callback]) → void -
Stop listening for a whisper event on the channel instance.
inherited
-
subscribe(
) → Future< void> -
Subscribe to a Socket.io channel.
inherited
-
subscribed(
Function callback) → void -
Register a callback to be called anytime a subscription succeeds.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
unbind(
) → void -
Unbind the channel's socket from all stored event callbacks.
inherited
-
unsubscribe(
) → Future< void> -
Unsubscribe from channel and unbind event callbacks.
inherited
-
whisper(
String eventName, dynamic data) → void -
Trigger client event on the channel.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited