An ErrorInfo object describing the last error which occurred on the channel, if any.
An array of ChannelMode objects.
Readonly name
The channel name.
Optional channel parameters that configure the behavior of the channel.
Readonly state
The current ChannelState of the channel.
Returns the listeners for a specified EventType.
Optional eventName: ChannelEvent
The event name to retrieve the listeners for.
Removes all registrations that match both the specified listener and the specified event.
The named event.
The event listener.
Deregisters the specified listener. Removes all registrations matching the given listener, regardless of whether they are associated with an event or not.
The event listener.
Deregisters all registrations, for all events and listeners.
Registers the provided listener for the specified event. If on() is called more than once with the same listener and event, the listener is added multiple times to its listener registry. Therefore, as an example, assuming the same listener is registered twice using on(), and an event is emitted once, the listener would be invoked twice.
The named event to listen for.
The event listener.
Registers the provided listener for the specified events. If on() is called more than once with the same listener and event, the listener is added multiple times to its listener registry. Therefore, as an example, assuming the same listener is registered twice using on(), and an event is emitted once, the listener would be invoked twice.
The named events to listen for.
The event listener.
Registers the provided listener all events. If on() is called more than once with the same listener and event, the listener is added multiple times to its listener registry. Therefore, as an example, assuming the same listener is registered twice using on(), and an event is emitted once, the listener would be invoked twice.
The event listener.
Registers the provided listener for the first occurrence of a single named event specified as the Event argument. If once is called more than once with the same listener, the listener is added multiple times to its listener registry. Therefore, as an example, assuming the same listener is registered twice using once, and an event is emitted once, the listener would be invoked twice. However, all subsequent events emitted would not invoke the listener as once ensures that each registration is only invoked once.
The named event to listen for.
The event listener.
Registers the provided listener for the first event that is emitted. If once() is called more than once with the same listener, the listener is added multiple times to its listener registry. Therefore, as an example, assuming the same listener is registered twice using once(), and an event is emitted once, the listener would be invoked twice. However, all subsequent events emitted would not invoke the listener as once() ensures that each registration is only invoked once.
The event listener.
Returns a promise which resolves upon the first occurrence of a single named event specified as the Event argument.
A promise which resolves upon the first occurrence of the named event.
The named event to listen for.
Returns a promise which resolves upon the first occurrence of an event.
A promise which resolves upon the first occurrence of an event.
Deregisters the given listener for the specified event name. This removes an earlier event-specific subscription.
The event name.
An event listener function.
Deregisters the given listener from all event names in the array.
An array of event names.
An event listener function.
Deregisters all listeners for the given event name.
The event name.
Deregisters all listeners for all event names in the array.
An array of event names.
Deregisters all listeners to messages on this channel that match the supplied filter.
Optional listener: messageCallback<Message>
An event listener function.
Deregisters the given listener (for any/all event names). This removes an earlier subscription.
An event listener function.
Deregisters all listeners to messages on this channel. This removes all earlier subscriptions.
Generated using TypeDoc
The
RealtimeChannelBaseclass acts as a base class for the RealtimeChannelCallbacks and RealtimeChannelPromise classes.