-
- All Implemented Interfaces:
-
io.ably.lib.types.ReadOnlyMap
public interface AblyRealtime.Channels implements ReadOnlyMap<String, Channel>
A collection of Channels associated with this Ably Realtime instance.
-
-
Method Summary
Modifier and Type Method Description abstract Channelget(String channelName)Creates a new Channel object, or returns the existing channel object. abstract Channelget(String channelName, ChannelOptions channelOptions)Creates a new Channel object, with the specified ChannelOptions, or returns the existing channel object. abstract voidrelease(String channelName)Releases a Channel object, deleting it, and enabling it to be garbage collected.It also removes any listeners associated with the channel. -
-
Method Detail
-
get
abstract Channel get(String channelName)
Creates a new Channel object, or returns the existing channel object.
Spec: RSN3a, RTS3a
- Parameters:
channelName- The channel name.
-
get
abstract Channel get(String channelName, ChannelOptions channelOptions)
Creates a new Channel object, with the specified ChannelOptions, or returns the existing channel object.
Spec: RSN3c, RTS3c
- Parameters:
channelName- The channel name.channelOptions- A ChannelOptions object.
-
release
abstract void release(String channelName)
Releases a Channel 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.
Spec: RSN4, RTS4
- Parameters:
channelName- The channel name.
-
-
-
-