Creates a new Channel or RealtimeChannel object, with the specified ChannelOptions, or returns the existing channel object.
The channel name.
Optional
channelOptions: ChannelOptions
A ChannelOptions object.
A Channel or RealtimeChannel object.
Experimental
Creates a new Channel or RealtimeChannel 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.
The channel name.
A DeriveOptions object.
Optional
channelOptions: ChannelOptions
A ChannelOptions object.
A RealtimeChannel object.
Releases a Channel or RealtimeChannel object, deleting it, and enabling it to be garbage collected. To release a channel, the ChannelState must be INITIALIZED
, DETACHED
, or FAILED
.
The channel name.
Generated using TypeDoc
Creates and destroys Channel and RealtimeChannel objects.