public final class Channels
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
Channels.ChannelBuilder |
Modifier and Type | Method and Description |
---|---|
Channels.ChannelBuilder |
channelBuilder()
Get ChannelBuilder to create channel with options.
|
void |
createChannel(java.lang.String friendlyName,
Channel.ChannelType type,
CallbackListener<Channel> listener)
Create a channel with friendly name and type.
|
void |
dispose() |
void |
getChannel(java.lang.String channelSidOrUniqueName,
CallbackListener<Channel> listener)
Retrieves a channel with the specified sid or unique name.
|
java.util.List<Member> |
getMembersByIdentity(java.lang.String identity)
Get list of _all_ Channel members with a given identity.
|
void |
getPublicChannelsList(CallbackListener<Paginator<ChannelDescriptor>> listener)
Request list of public channels user have not joined.
|
java.util.List<Channel> |
getSubscribedChannels()
Request list of user's joined channels.
|
void |
getUserChannelsList(CallbackListener<Paginator<ChannelDescriptor>> listener)
Request list of channels user have joined.
|
public void createChannel(java.lang.String friendlyName, @NonNull Channel.ChannelType type, CallbackListener<Channel> listener)
friendlyName
- Friendly name of the new channel.type
- Channel typelistener
- Listener that receives the status of create channel action.public Channels.ChannelBuilder channelBuilder()
A pattern to build channel with options is:
channels.channelBuilder()
.withFriendlyName("Channel")
.withType(Channel.ChannelType.PRIVATE)
.build(listener);
public void getChannel(java.lang.String channelSidOrUniqueName, CallbackListener<Channel> listener)
channelSidOrUniqueName
- Identifier for the channel.listener
- Listener to receive the channel.public void getPublicChannelsList(CallbackListener<Paginator<ChannelDescriptor>> listener)
This command will return a list of ChannelDescriptor
s. These are the channels that
are public and are not joined by current user. To get channels already joined by current
user see getUserChannelsList(com.twilio.chat.CallbackListener<com.twilio.chat.Paginator<com.twilio.chat.ChannelDescriptor>>)
.
Returned list is wrapped in a pagination interface
.
listener
- Listener to receive a paginator with first page of results.
Use paginator interface to request subsequent pages.public void getUserChannelsList(CallbackListener<Paginator<ChannelDescriptor>> listener)
This command will return a list of ChannelDescriptor
s. These are the channels that
are joined by current user, regardless of if they are public or private. To get public
channels not yet joined by current user see getPublicChannelsList(com.twilio.chat.CallbackListener<com.twilio.chat.Paginator<com.twilio.chat.ChannelDescriptor>>)
.
Returned list is wrapped in a pagination interface
.
listener
- Listener to receive a paginator with first page of results.
Use paginator interface to request subsequent pages.public java.util.List<Channel> getSubscribedChannels()
public java.util.List<Member> getMembersByIdentity(java.lang.String identity)
identity
- Member identity to look up.public void dispose()