
public final class OpenChannel
extends BaseChannel

Represents an open channel.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`OpenChannel.OpenChannelRefreshHandler`	OpenChannelRefresh handler. This handler provides callback for refresh.
`public interface`	`OpenChannel.OpenChannelEnterHandler`	OpenChannelEnter handler. This handler provides callback for enter.
`public interface`	`OpenChannel.OpenChannelExitHandler`	OpenChannelExit handler. This handler provides callback for exit.
`public interface`	`OpenChannel.OpenChannelGetHandler`	OpenChannelGet handler. This handler provides callback for getChannel.
`public interface`	`OpenChannel.OpenChannelCreateHandler`	OpenChannelCreate handler. This handler provides callback for createChannel, createChannel, createChannel, createChannelWithOperatorUserIds, createChannelWithOperatorUserIds, createChannelWithOperatorUserIds and createChannel.
`public interface`	`OpenChannel.OpenChannelUpdateHandler`	OpenChannelUpdate handler. This handler provides callback for updateChannel, updateChannel, updateChannelWithOperatorUserIds and updateChannel.
`public interface`	`OpenChannel.OpenChannelBanHandler`	OpenChannelBan handler. This handler provides callback for banUser and banUserWithUserId.
`public interface`	`OpenChannel.OpenChannelUnbanHandler`	OpenChannelUnban handler. This handler provides callback for unbanUser and unbanUserWithUserId.
`public interface`	`OpenChannel.OpenChannelMuteHandler`	OpenChannelMute handler. This handler provides callback for muteUser and muteUserWithUserId.
`public interface`	`OpenChannel.OpenChannelUnmuteHandler`	OpenChannelUnmute handler. This handler provides callback for unmuteUser and unmuteUserWithUserId.
`public interface`	`OpenChannel.OpenChannelDeleteHandler`

Method Summary

Modifier and Type	Method	Description
`void`	`refresh(OpenChannel.OpenChannelRefreshHandler handler)`	Refreshes all the data of this channel.
`int`	`getParticipantCount()`	Gets the total number of participants in this channel.
`List<User>`	`getOperators()`	Gets channel operators.
`String`	`getCustomType()`	Gets channel custom type.
`static OpenChannelListQuery`	`createOpenChannelListQuery()`	Creates a query instance to get `OpenChannel`s.
`static void`	`createChannel(OpenChannel.OpenChannelCreateHandler handler)`	Creates new `OpenChannel`.
`static void`	`createChannel(String name, Object coverUrlOrImage, String data, OpenChannel.OpenChannelCreateHandler handler)`	Creates new `OpenChannel` with given information.
`static void`	`createChannel(String name, Object coverUrlOrImage, String data, List<User> operatorUsers, OpenChannel.OpenChannelCreateHandler handler)`	Creates new `OpenChannel` with given information.
`static void`	`createChannel(String name, Object coverUrlOrImage, String data, String customType, List<User> operatorUsers, OpenChannel.OpenChannelCreateHandler handler)`	Creates new `OpenChannel` with given information.
`static void`	`createChannelWithOperatorUserIds(String name, Object coverUrlOrImage, String data, List<String> operatorUserIds, OpenChannel.OpenChannelCreateHandler handler)`	Creates new `OpenChannel` with given information.
`static void`	`createChannelWithOperatorUserIds(String name, Object coverUrlOrImage, String data, String customType, List<String> operatorUserIds, OpenChannel.OpenChannelCreateHandler handler)`	Creates new `OpenChannel` with given information.
`static void`	`createChannelWithOperatorUserIds(String name, String channelUrl, Object coverUrlOrImage, String data, String customType, List<String> operatorUserIds, OpenChannel.OpenChannelCreateHandler handler)`	Creates new `OpenChannel` with given information.
`static void`	`createChannel(OpenChannelParams params, OpenChannel.OpenChannelCreateHandler handler)`	Creates new `OpenChannel` with OpenChannelParams.
`static void`	`getChannel(String channelUrl, OpenChannel.OpenChannelGetHandler handler)`	Gets a `OpenChannel` with given channel URL.
`void`	`delete(OpenChannel.OpenChannelDeleteHandler handler)`	Deletes an `OpenChannel`.
`void`	`updateChannel(String name, Object coverUrlOrImage, String data, OpenChannel.OpenChannelUpdateHandler handler)`	Updates this channel.
`void`	`updateChannel(String name, Object coverUrlOrImage, String data, List<User> operatorUsers, OpenChannel.OpenChannelUpdateHandler handler)`	Updates this channel.
`void`	`updateChannel(String name, Object coverUrlOrImage, String data, String customType, List<User> operatorUsers, OpenChannel.OpenChannelUpdateHandler handler)`	Updates this channel.
`void`	`updateChannelWithOperatorUserIds(String name, Object coverUrlOrImage, String data, List<String> operatorUserIds, OpenChannel.OpenChannelUpdateHandler handler)`	Updates this channel.
`void`	`updateChannelWithOperatorUserIds(String name, Object coverUrlOrImage, String data, String customType, List<String> operatorUserIds, OpenChannel.OpenChannelUpdateHandler handler)`	Updates this channel.
`void`	`updateChannel(OpenChannelParams params, OpenChannel.OpenChannelUpdateHandler handler)`	Update this channel with OpenChannelParams.
`void`	`enter(OpenChannel.OpenChannelEnterHandler handler)`	Enters this channel.
`void`	`exit(OpenChannel.OpenChannelExitHandler handler)`	Exits from this channel.
`ParticipantListQuery`	`createParticipantListQuery()`	Creates a query instance to get the whole participant list (online only) of this channel.
`MutedUserListQuery`	`createMutedUserListQuery()`	Creates a query instance to get the muted user (online and offline both) list of this channel.
`BannedUserListQuery`	`createBannedUserListQuery()`	Creates a query instance to get the banned user list from this channel.
`void`	`banUser(User user, int seconds, OpenChannel.OpenChannelBanHandler handler)`	Bans a participant.
`void`	`banUserWithUserId(String userId, int seconds, OpenChannel.OpenChannelBanHandler handler)`	Bans a participant.
`void`	`unbanUser(User user, OpenChannel.OpenChannelUnbanHandler handler)`	Unbans `User`.
`void`	`unbanUserWithUserId(String userId, OpenChannel.OpenChannelUnbanHandler handler)`	Unbans `User`.
`void`	`muteUser(User user, OpenChannel.OpenChannelMuteHandler handler)`	Mutes `User`.
`void`	`muteUserWithUserId(String userId, OpenChannel.OpenChannelMuteHandler handler)`	Mutes `User`.
`void`	`muteUser(User user, String description, int seconds, OpenChannel.OpenChannelMuteHandler handler)`	Mutes `User`.
`void`	`muteUserWithUserId(String userId, String description, int seconds, OpenChannel.OpenChannelMuteHandler handler)`	Mutes `User`.
`void`	`unmuteUser(User user, OpenChannel.OpenChannelUnmuteHandler handler)`	Unmutes `User`.
`void`	`unmuteUserWithUserId(String userId, OpenChannel.OpenChannelUnmuteHandler handler)`	Unmutes `User`.
`boolean`	`isOperator(User user)`	Checks if the given `User` is an operator of this channel.
`boolean`	`isOperatorWithUserId(String userId)`	Checks if the given `User` is an operator of this channel.
`String`	`toString()`
`static OpenChannel`	`clone(OpenChannel channel)`	Clones and returns a new instance of given OpenChannel

Methods inherited from class com.sendbird.android.BaseChannel
addMessageMetaArrayValues, addMessageMetaArrayValues, addOperators, addReaction, buildFromSerializedData, cancelFileMessageUpload, copyFileMessage, copyUserMessage, createMessageListQuery, createMessageMetaArrayKeys, createMetaCounters, createMetaData, createOperatorListQuery, createPollListQuery, createPollVoterListQuery, createPreviousMessageListQuery, decreaseMetaCounters, deleteAllMetaCounters, deleteAllMetaData, deleteMessage, deleteMessageMetaArrayKeys, deleteMetaCounter, deleteMetaData, deleteReaction, equals, getAllMetaCounters, getAllMetaData, getCachedMetaData, getCoverUrl, getCreatedAt, getData, getMessageChangeLogsByTimestamp, getMessageChangeLogsByTimestamp, getMessageChangeLogsByTimestamp, getMessageChangeLogsByToken, getMessageChangeLogsByToken, getMessageChangeLogsByToken, getMessageChangeLogsSinceTimestamp, getMessageChangeLogsSinceToken, getMessagesByMessageId, getMessagesByTimestamp, getMetaCounters, getMetaData, getMyMutedInfo, getName, getNextMessagesById, getNextMessagesById, getNextMessagesById, getNextMessagesById, getNextMessagesByTimestamp, getNextMessagesByTimestamp, getNextMessagesByTimestamp, getNextMessagesByTimestamp, getPreviousAndNextMessagesById, getPreviousAndNextMessagesById, getPreviousAndNextMessagesById, getPreviousAndNextMessagesById, getPreviousAndNextMessagesByTimestamp, getPreviousAndNextMessagesByTimestamp, getPreviousAndNextMessagesByTimestamp, getPreviousAndNextMessagesByTimestamp, getPreviousMessagesById, getPreviousMessagesById, getPreviousMessagesById, getPreviousMessagesById, getPreviousMessagesByTimestamp, getPreviousMessagesByTimestamp, getPreviousMessagesByTimestamp, getPreviousMessagesByTimestamp, getUrl, hashCode, increaseMetaCounters, isEphemeral, isFrozen, isGroupChannel, isOpenChannel, removeAllOperators, removeMessageMetaArrayValues, removeMessageMetaArrayValues, removeOperators, report, reportMessage, reportUser, resendFileMessage, resendFileMessage, resendMessage, resendMessage, resendMessage, resendUserMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessages, sendFileMessages, sendUserMessage, sendUserMessage, sendUserMessage, sendUserMessage, sendUserMessage, serialize, translateUserMessage, updateFileMessage, updateFileMessage, updateMetaCounters, updateMetaData, updateUserMessage, updateUserMessage
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - refresh
```
 void refresh(OpenChannel.OpenChannelRefreshHandler handler)
```
    Refreshes all the data of this channel.
    
    Parameters:
    
    handler - Callback handler.
  - getParticipantCount
```
 int getParticipantCount()
```
    Gets the total number of participants in this channel.
  - getOperators
```
 List<User> getOperators()
```
    Gets channel operators.
  - getCustomType
```
 String getCustomType()
```
    Gets channel custom type. You can set custom type of this channel by createChannel, createChannelWithOperatorUserIds, updateChannel or updateChannelWithOperatorUserIds.
  - createOpenChannelListQuery
```
 static OpenChannelListQuery createOpenChannelListQuery()
```
    Creates a query instance to get OpenChannels.
  - createChannel
```
 static void createChannel(OpenChannel.OpenChannelCreateHandler handler)
```
    Creates new OpenChannel.
    
    Parameters:
    
    handler - Callback handler.
  - createChannel
```
@Deprecated() static void createChannel(String name, Object coverUrlOrImage, String data, OpenChannel.OpenChannelCreateHandler handler)
```
    Creates new OpenChannel with given information.
    
    Parameters:
    
    name - Name of channel.
    
    coverUrlOrImage - Cover URL or image file of channel.
    
    data - Custom data.
    
    handler - Callback handler.
  - createChannel
```
@Deprecated() static void createChannel(String name, Object coverUrlOrImage, String data, List<User> operatorUsers, OpenChannel.OpenChannelCreateHandler handler)
```
    Creates new OpenChannel with given information.
    
    Parameters:
    
    name - Name of channel.
    
    coverUrlOrImage - Cover URL or image file of channel.
    
    data - Custom data.
    
    operatorUsers - Operators.
    
    handler - Callback handler.
  - createChannel
```
 static void createChannel(String name, Object coverUrlOrImage, String data, String customType, List<User> operatorUsers, OpenChannel.OpenChannelCreateHandler handler)
```
    Creates new OpenChannel with given information.
    
    Parameters:
    
    name - Name of channel.
    
    coverUrlOrImage - Cover URL or image file of channel.
    
    data - Custom data.
    
    customType - Custom type.
    
    operatorUsers - Operators.
    
    handler - Callback handler.
  - createChannelWithOperatorUserIds
```
 static void createChannelWithOperatorUserIds(String name, Object coverUrlOrImage, String data, List<String> operatorUserIds, OpenChannel.OpenChannelCreateHandler handler)
```
    Creates new OpenChannel with given information.
    
    Parameters:
    
    name - Name of channel.
    
    coverUrlOrImage - Cover URL or image file of channel.
    
    data - Custom data.
    
    operatorUserIds - Operator IDs (User IDs).
    
    handler - Callback handler.
  - createChannelWithOperatorUserIds
```
 static void createChannelWithOperatorUserIds(String name, Object coverUrlOrImage, String data, String customType, List<String> operatorUserIds, OpenChannel.OpenChannelCreateHandler handler)
```
    Creates new OpenChannel with given information.
    
    Parameters:
    
    name - Name of channel.
    
    coverUrlOrImage - Cover URL or image file of channel.
    
    data - Custom data.
    
    customType - Custom type.
    
    operatorUserIds - Operator IDs (User IDs).
    
    handler - Callback handler.
  - createChannelWithOperatorUserIds
```
 static void createChannelWithOperatorUserIds(String name, String channelUrl, Object coverUrlOrImage, String data, String customType, List<String> operatorUserIds, OpenChannel.OpenChannelCreateHandler handler)
```
    Creates new OpenChannel with given information.
    
    Parameters:
    
    name - Name of channel.
    
    channelUrl - The channel URL.
    
    coverUrlOrImage - Cover URL or image file of channel.
    
    data - Custom data.
    
    customType - Custom type.
    
    operatorUserIds - Operator IDs (User IDs).
    
    handler - Callback handler.
  - createChannel
```
 static void createChannel(OpenChannelParams params, OpenChannel.OpenChannelCreateHandler handler)
```
    Creates new OpenChannel with OpenChannelParams.
    
    Parameters:
    
    params - Params of channel.
    
    handler - Callback handler.
  - getChannel
```
 static void getChannel(String channelUrl, OpenChannel.OpenChannelGetHandler handler)
```
    Gets a OpenChannel with given channel URL.
    
    Parameters:
    
    channelUrl - URL of channel.
    
    handler - Callback handler.
  - delete
```
 void delete(OpenChannel.OpenChannelDeleteHandler handler)
```
    Deletes an OpenChannel. Note that only operators of a channel are able to delete it or else, an error will be returned to the handler.
    
    Parameters:
    
    handler - The callback handler.
  - updateChannel
```
 void updateChannel(String name, Object coverUrlOrImage, String data, OpenChannel.OpenChannelUpdateHandler handler)
```
    Updates this channel. If null is passed for each parameter, the current value of each is maintained.
    
    Parameters:
    
    name - New name.
    
    coverUrlOrImage - New cover URL or image file of channel.
    
    data - New custom data.
    
    handler - Callback handler.
  - updateChannel
```
@Deprecated() void updateChannel(String name, Object coverUrlOrImage, String data, List<User> operatorUsers, OpenChannel.OpenChannelUpdateHandler handler)
```
    Updates this channel. If null is passed for each parameter, the current value of each is maintained.
    
    Parameters:
    
    name - New name.
    
    coverUrlOrImage - New cover URL or image file of channel.
    
    data - New custom data.
    
    operatorUsers - New operators.
    
    handler - Callback handler.
  - updateChannel
```
 void updateChannel(String name, Object coverUrlOrImage, String data, String customType, List<User> operatorUsers, OpenChannel.OpenChannelUpdateHandler handler)
```
    Updates this channel. If null is passed for each parameter, the current value of each is maintained.
    
    Parameters:
    
    name - New name.
    
    coverUrlOrImage - New cover URL or image file of channel.
    
    data - New custom data.
    
    customType - New custom type.
    
    operatorUsers - New operators.
    
    handler - Callback handler.
  - updateChannelWithOperatorUserIds
```
 void updateChannelWithOperatorUserIds(String name, Object coverUrlOrImage, String data, List<String> operatorUserIds, OpenChannel.OpenChannelUpdateHandler handler)
```
    Updates this channel. If null is passed for each parameter, the current value of each is maintained.
    
    Parameters:
    
    name - New name.
    
    coverUrlOrImage - New cover URL or image file of channel.
    
    data - New custom data.
    
    operatorUserIds - New operator IDs.
    
    handler - Callback handler.
  - updateChannelWithOperatorUserIds
```
 void updateChannelWithOperatorUserIds(String name, Object coverUrlOrImage, String data, String customType, List<String> operatorUserIds, OpenChannel.OpenChannelUpdateHandler handler)
```
    Updates this channel. If null is passed for each parameter, the current value of each is maintained.
    
    Parameters:
    
    name - New name.
    
    coverUrlOrImage - New cover URL or image file of channel.
    
    data - New custom data.
    
    customType - New custom type.
    
    operatorUserIds - New operator IDs.
    
    handler - Callback handler.
  - updateChannel
```
 void updateChannel(OpenChannelParams params, OpenChannel.OpenChannelUpdateHandler handler)
```
    Update this channel with OpenChannelParams.
    
    Parameters:
    
    params - Params of channel.
    
    handler - Callback handler.
  - enter
```
 void enter(OpenChannel.OpenChannelEnterHandler handler)
```
    Enters this channel. The current User becomes a participant of this channel.
    
    Parameters:
    
    handler - Callback handler.
  - exit
```
 void exit(OpenChannel.OpenChannelExitHandler handler)
```
    Exits from this channel. The current User is no longer a participant of this channel.
    
    Parameters:
    
    handler - Callback handler.
  - createParticipantListQuery
```
 ParticipantListQuery createParticipantListQuery()
```
    Creates a query instance to get the whole participant list (online only) of this channel.
  - createMutedUserListQuery
```
 MutedUserListQuery createMutedUserListQuery()
```
    Creates a query instance to get the muted user (online and offline both) list of this channel.
  - createBannedUserListQuery
```
 BannedUserListQuery createBannedUserListQuery()
```
    Creates a query instance to get the banned user list from this channel.
  - banUser
```
 void banUser(User user, int seconds, OpenChannel.OpenChannelBanHandler handler)
```
    Bans a participant. Operators can ban participants from this channel.Banned participant is kicked out of this channel and cannot enter during the specified seconds.If you want to ban the user indefinitely, pass -1 to seconds as the argument.
    
    Parameters:
    
    user - Participant to ban.
    
    seconds - Duration the banned User cannot enter this channel again.
    
    handler - Callback handler.
  - banUserWithUserId
```
 void banUserWithUserId(String userId, int seconds, OpenChannel.OpenChannelBanHandler handler)
```
    Bans a participant. Operators can ban participants from this channel.Banned participant is kicked out of this channel and cannot enter during the specified seconds.If you want to ban the user indefinitely, pass -1 to seconds as the argument.
    
    Parameters:
    
    userId - Participant ID (User ID) to ban.
    
    seconds - Duration the banned User cannot enter this channel again.
    
    handler - Callback handler.
  - unbanUser
```
 void unbanUser(User user, OpenChannel.OpenChannelUnbanHandler handler)
```
    Unbans User. Operators can unban User who has been banned from this channel.
    
    Parameters:
    
    user - User to unban.
    
    handler - Callback handler.
  - unbanUserWithUserId
```
 void unbanUserWithUserId(String userId, OpenChannel.OpenChannelUnbanHandler handler)
```
    Unbans User. Operators can unban User who has been banned from this channel.
    
    Parameters:
    
    userId - User ID to unban.
    
    handler - Callback handler.
  - muteUser
```
 void muteUser(User user, OpenChannel.OpenChannelMuteHandler handler)
```
    Mutes User. Muted User's messages are no longer delivered to current User.
    
    Parameters:
    
    user - User to mute.
    
    handler - Callback handler.
  - muteUserWithUserId
```
 void muteUserWithUserId(String userId, OpenChannel.OpenChannelMuteHandler handler)
```
    Mutes User. Muted User's messages are no longer delivered to current User.
    
    Parameters:
    
    userId - User ID to mute.
    
    handler - Callback handler.
  - muteUser
```
 void muteUser(User user, String description, int seconds, OpenChannel.OpenChannelMuteHandler handler)
```
    Mutes User. Muted User's messages are no longer delivered to current User.If you want to mute the user indefinitely, pass -1 to seconds as the argument.Or you can use muteUser.
    
    Parameters:
    
    user - User to mute.
    
    description - Description.
    
    seconds - Duration for the mute.
    
    handler - Callback handler.
  - muteUserWithUserId
```
 void muteUserWithUserId(String userId, String description, int seconds, OpenChannel.OpenChannelMuteHandler handler)
```
    Mutes User. Muted User's messages are no longer delivered to current User.If you want to mute the user indefinitely, pass -1 to seconds as the argument.Or you can use muteUser.
    
    Parameters:
    
    userId - User ID to mute.
    
    description - Description.
    
    seconds - Duration for the mute.
    
    handler - Callback handler.
  - unmuteUser
```
 void unmuteUser(User user, OpenChannel.OpenChannelUnmuteHandler handler)
```
    Unmutes User. Unmuted User's messages are again shown to current User.
    
    Parameters:
    
    user - User to unmute.
    
    handler - Callback handler.
  - unmuteUserWithUserId
```
 void unmuteUserWithUserId(String userId, OpenChannel.OpenChannelUnmuteHandler handler)
```
    Unmutes User. Unmuted User's messages are again shown to current User.
    
    Parameters:
    
    userId - User ID to unmute.
    
    handler - Callback handler.
  - isOperator
```
 boolean isOperator(User user)
```
    Checks if the given User is an operator of this channel.
    
    Parameters:
    
    user - User to check.
  - isOperatorWithUserId
```
 boolean isOperatorWithUserId(String userId)
```
    Checks if the given User is an operator of this channel.
    
    Parameters:
    
    userId - User ID to check.
  - toString
```
 String toString()
```
  - clone
```
 static OpenChannel clone(OpenChannel channel)
```
    Clones and returns a new instance of given OpenChannel
    
    Parameters:
    
    channel - OpenChannel to clone

Class OpenChannel

Nested Class Summary

Method Summary

Methods inherited from class com.sendbird.android.BaseChannel

Methods inherited from class java.lang.Object

Method Detail

refresh

getParticipantCount

getOperators

getCustomType

createOpenChannelListQuery

createChannel

createChannel

createChannel

createChannel

createChannelWithOperatorUserIds

createChannelWithOperatorUserIds

createChannelWithOperatorUserIds

createChannel

getChannel

delete

updateChannel

updateChannel

updateChannel

updateChannelWithOperatorUserIds

updateChannelWithOperatorUserIds

updateChannel

enter

exit

createParticipantListQuery

createMutedUserListQuery

createBannedUserListQuery

banUser

banUserWithUserId

unbanUser

unbanUserWithUserId

muteUser

muteUserWithUserId

muteUser

muteUserWithUserId

unmuteUser

unmuteUserWithUserId

isOperator

isOperatorWithUserId

toString

clone