Creates a new ChannelBase or RealtimeChannelBase object, with the specified ChannelOptions, or returns the existing channel object.
A ChannelBase or RealtimeChannelBase object.
The channel name.
Optional
channelOptions: ChannelOptions
A ChannelOptions object.
Experimental
Creates a new ChannelBase or RealtimeChannelBase object, with the specified channel DeriveOptions and ChannelOptions, or returns the existing channel object.
This is a preview feature and may change in a future non-major release. This experimental method allows you to create custom realtime data feeds by selectively subscribing to receive only part of the data from the channel. See the announcement post for more information.
A RealtimeChannelBase object.
The channel name.
A DeriveOptions object.
Optional
channelOptions: ChannelOptions
A ChannelOptions object.
Releases a ChannelBase or RealtimeChannelBase object, deleting it, and enabling it to be garbage collected. It also removes any listeners associated with the channel. To release a channel, the ChannelState must be INITIALIZED
, DETACHED
, or FAILED
.
The channel name.
Generated using TypeDoc
Creates and destroys ChannelBase and RealtimeChannelBase objects.