Class Channel

applyStatus applies the channel status into this channel.

broadcast sends a message to all clients watching this channel.

getActorID returns the actor ID of this channel.

getFirstKeyPath returns the first key path to the presence count.

getKey returns the key of this channel.

getSessionCount returns the current channel online session count value.

getSessionID returns the session ID from the server.

getStatus returns the status of this channel.

hasLocalChanges returns whether this channel has local changes or not. Channel is server-managed, so it always returns false.

isAttached returns whether this channel is attached or not.

publish publishes an event to all registered handlers.

setActor sets the actor ID into this channel.

setSessionID sets the session ID from the server.

subscribe registers a callback to subscribe to events on the channel. The callback will be called when the broadcast event is received from the remote client.

subscribe registers a callback to subscribe to events on the channel. The callback will be called when the local client sends a broadcast event.

subscribe registers a callback to subscribe to events on the channel. The callback will be called when an authentication error occurs.

subscribe registers a callback to subscribe to non-recoverable sync (RefreshChannel) errors. Subsequent successful events on the channel imply recovery — there is no separate "recovered" event.

subscribe registers a callback to subscribe to presence events on the channel. The callback will be called when the presence count changes.

subscribe registers a callback to subscribe to all events on the channel.

subscribe registers a callback to subscribe to broadcast events for a specific topic. The callback will be called when a broadcast event with the matching topic is received.

subscribe registers an observer for all channel events. Returns an unsubscribe function.

updateSessionCount updates the session count and sequence number if the sequence is newer. Returns true if the count was updated, false if the update was ignored.