com.sendbird.android

Class OpenChannel

java.lang.Object

com.sendbird.android.BaseChannel

com.sendbird.android.OpenChannel

public final class OpenChannel
extends BaseChannel

Represents an open channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OpenChannel.OpenChannelBanHandler OpenChannelBan handler.
static interface	OpenChannel.OpenChannelCreateHandler OpenChannelCreate handler.
static interface	OpenChannel.OpenChannelDeleteHandler
static interface	OpenChannel.OpenChannelEnterHandler OpenChannelEnter handler.
static interface	OpenChannel.OpenChannelExitHandler OpenChannelExit handler.
static interface	OpenChannel.OpenChannelGetHandler OpenChannelGet handler.
static interface	OpenChannel.OpenChannelMuteHandler OpenChannelMute handler.
static interface	OpenChannel.OpenChannelRefreshHandler OpenChannelRefresh handler.
static interface	OpenChannel.OpenChannelUnbanHandler OpenChannelUnban handler.
static interface	OpenChannel.OpenChannelUnmuteHandler OpenChannelUnmute handler.
static interface	OpenChannel.OpenChannelUpdateHandler OpenChannelUpdate handler.

Nested classes/interfaces inherited from class com.sendbird.android.BaseChannel

BaseChannel.BaseSendFileMessageHandler, BaseChannel.ChannelType, BaseChannel.CopyFileMessageHandler, BaseChannel.CopyUserMessageHandler, BaseChannel.DeleteMessageHandler, BaseChannel.DeleteMetaCounterHandler, BaseChannel.DeleteMetaDataHandler, BaseChannel.GetMessageChangeLogsByTokenHandler, BaseChannel.GetMessageChangeLogsHandler, BaseChannel.GetMessagesHandler, BaseChannel.GetMyMutedInfoHandler, BaseChannel.MessageMetaArrayHandler, BaseChannel.MessageTypeFilter, BaseChannel.MetaCounterHandler, BaseChannel.MetaDataHandler, BaseChannel.ReactionHandler, BaseChannel.ReportCategory, BaseChannel.ReportHandler, BaseChannel.ReportMessageHandler, BaseChannel.ReportUserHandler, BaseChannel.ResendFileMessageHandler, BaseChannel.ResendFileMessageWithProgressHandler, BaseChannel.ResendUserMessageHandler, BaseChannel.SendFileMessageHandler, BaseChannel.SendFileMessagesHandler, BaseChannel.SendFileMessagesWithProgressHandler, BaseChannel.SendFileMessageWithProgressHandler, BaseChannel.SendUserMessageHandler, BaseChannel.TranslateUserMessageHandler, BaseChannel.UpdateFileMessageHandler, BaseChannel.UpdateUserMessageHandler

Method Summary

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

Methods inherited from class com.sendbird.android.BaseChannel

addMessageMetaArrayValues, addMessageMetaArrayValues, addOperators, addReaction, buildFromSerializedData, cancelFileMessageUpload, copyFileMessage, copyUserMessage, createMessageListQuery, createMessageMetaArrayKeys, createMetaCounters, createMetaData, createOperatorListQuery, 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

getClass, notify, notifyAll, wait, wait, wait

Method Detail

refresh

public void refresh(OpenChannel.OpenChannelRefreshHandler handler)

Refreshes all the data of this channel.

Parameters:

handler - Callback handler.

getParticipantCount

public int getParticipantCount()

Gets the total number of participants in this channel.

Returns:

Total participants count.

getOperators

public java.util.List<User> getOperators()

Gets channel operators.

Returns:

UnmodifiableList of operators.

getCustomType

public java.lang.String getCustomType()

Gets channel custom type. You can set custom type of this channel by createChannel(String, Object, String, String, List, OpenChannelCreateHandler), createChannelWithOperatorUserIds(String, Object, String, String, List, OpenChannelCreateHandler), updateChannel(String, Object, String, String, List, OpenChannelUpdateHandler) or updateChannelWithOperatorUserIds(String, Object, String, String, List, OpenChannelUpdateHandler).

Returns:

Custom type of this channel.

Since:

3.0.9

createOpenChannelListQuery

public static OpenChannelListQuery createOpenChannelListQuery()

Creates a query instance to get OpenChannels.

Returns:

Query to use.

createChannel

public static void createChannel(OpenChannel.OpenChannelCreateHandler handler)

Creates new OpenChannel.

Parameters:

handler - Callback handler.

createChannel

@Deprecated
public static void createChannel(java.lang.String name,
                                             java.lang.Object coverUrlOrImage,
                                             java.lang.String data,
                                             OpenChannel.OpenChannelCreateHandler handler)
                                      throws java.lang.ClassCastException

Deprecated. As of 3.0.75, replaced by createChannel(String, Object, String, String, List, OpenChannelCreateHandler)

Creates new OpenChannel with given information.

Parameters:

name - Name of channel.

coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.

data - Custom data.

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.5

createChannel

@Deprecated
public static void createChannel(java.lang.String name,
                                             java.lang.Object coverUrlOrImage,
                                             java.lang.String data,
                                             java.util.List<User> operatorUsers,
                                             OpenChannel.OpenChannelCreateHandler handler)
                                      throws java.lang.ClassCastException

Deprecated. As of 3.0.75, replaced by createChannel(String, Object, String, String, List, OpenChannelCreateHandler)

Creates new OpenChannel with given information.

Parameters:

name - Name of channel.

coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.

data - Custom data.

operatorUsers - Operators. Operators can ban or unban other participants (refer to banUser(User, int, OpenChannelBanHandler) and unbanUser(User, OpenChannelUnbanHandler)).

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.5

createChannel

public static void createChannel(java.lang.String name,
                                 java.lang.Object coverUrlOrImage,
                                 java.lang.String data,
                                 java.lang.String customType,
                                 java.util.List<User> operatorUsers,
                                 OpenChannel.OpenChannelCreateHandler handler)
                          throws java.lang.ClassCastException

Creates new OpenChannel with given information.

Parameters:

name - Name of channel.

coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.

data - Custom data.

customType - Custom type.

operatorUsers - Operators. Operators can ban or unban other participants (refer to banUser(User, int, OpenChannelBanHandler) and unbanUser(User, OpenChannelUnbanHandler)).

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.9

createChannelWithOperatorUserIds

public static void createChannelWithOperatorUserIds(java.lang.String name,
                                                    java.lang.Object coverUrlOrImage,
                                                    java.lang.String data,
                                                    java.util.List<java.lang.String> operatorUserIds,
                                                    OpenChannel.OpenChannelCreateHandler handler)
                                             throws java.lang.ClassCastException

Creates new OpenChannel with given information.

Parameters:

name - Name of channel.

coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.

data - Custom data.

operatorUserIds - Operator IDs (User IDs). Operators can ban or unban other participants (refer to banUser(User, int, OpenChannelBanHandler) and unbanUser(User, OpenChannelUnbanHandler)).

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.5

createChannelWithOperatorUserIds

public static void createChannelWithOperatorUserIds(java.lang.String name,
                                                    java.lang.Object coverUrlOrImage,
                                                    java.lang.String data,
                                                    java.lang.String customType,
                                                    java.util.List<java.lang.String> operatorUserIds,
                                                    OpenChannel.OpenChannelCreateHandler handler)
                                             throws java.lang.ClassCastException

Creates new OpenChannel with given information.

Parameters:

name - Name of channel.

coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.

data - Custom data.

customType - Custom type.

operatorUserIds - Operator IDs (User IDs). Operators can ban or unban other participants (refer to banUser(User, int, OpenChannelBanHandler) and unbanUser(User, OpenChannelUnbanHandler)).

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.9

createChannelWithOperatorUserIds

public static void createChannelWithOperatorUserIds(java.lang.String name,
                                                    java.lang.String channelUrl,
                                                    java.lang.Object coverUrlOrImage,
                                                    java.lang.String data,
                                                    java.lang.String customType,
                                                    java.util.List<java.lang.String> operatorUserIds,
                                                    OpenChannel.OpenChannelCreateHandler handler)
                                             throws java.lang.ClassCastException

Creates new OpenChannel with given information.

Parameters:

name - Name of channel.

channelUrl - The channel URL. If null, channel url will be determined randomly.

coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.

data - Custom data.

customType - Custom type.

operatorUserIds - Operator IDs (User IDs). Operators can ban or unban other participants (refer to banUser(User, int, OpenChannelBanHandler) and unbanUser(User, OpenChannelUnbanHandler)).

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.96

createChannel

public static void createChannel(OpenChannelParams params,
                                 OpenChannel.OpenChannelCreateHandler handler)

Creates new OpenChannel with OpenChannelParams.

Parameters:

params - Params of channel. Refer to OpenChannelParams.

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.150

getChannel

public static void getChannel(java.lang.String channelUrl,
                              OpenChannel.OpenChannelGetHandler handler)

Gets a OpenChannel with given channel URL.

Parameters:

channelUrl - URL of channel. Refer to BaseChannel.getUrl().

handler - Callback handler.

delete

public 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

public void updateChannel(java.lang.String name,
                          java.lang.Object coverUrlOrImage,
                          java.lang.String data,
                          OpenChannel.OpenChannelUpdateHandler handler)
                   throws java.lang.ClassCastException

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. Pass String, File or null only, throws exception otherwise.

data - New custom data.

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.5

updateChannel

@Deprecated
public void updateChannel(java.lang.String name,
                                      java.lang.Object coverUrlOrImage,
                                      java.lang.String data,
                                      java.util.List<User> operatorUsers,
                                      OpenChannel.OpenChannelUpdateHandler handler)
                               throws java.lang.ClassCastException

Deprecated. As of 3.0.75, replaced by updateChannel(String, Object, String, String, List, OpenChannelUpdateHandler)

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. Pass String, File or null only, throws exception otherwise.

data - New custom data.

operatorUsers - New operators.

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.5

updateChannel

public void updateChannel(java.lang.String name,
                          java.lang.Object coverUrlOrImage,
                          java.lang.String data,
                          java.lang.String customType,
                          java.util.List<User> operatorUsers,
                          OpenChannel.OpenChannelUpdateHandler handler)
                   throws java.lang.ClassCastException

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. Pass String, File or null only, throws exception otherwise.

data - New custom data.

customType - New custom type.

operatorUsers - New operators.

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.9

updateChannelWithOperatorUserIds

public void updateChannelWithOperatorUserIds(java.lang.String name,
                                             java.lang.Object coverUrlOrImage,
                                             java.lang.String data,
                                             java.util.List<java.lang.String> operatorUserIds,
                                             OpenChannel.OpenChannelUpdateHandler handler)
                                      throws java.lang.ClassCastException

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. Pass String, File or null only, throws exception otherwise.

data - New custom data.

operatorUserIds - New operator IDs.

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.5

updateChannelWithOperatorUserIds

public void updateChannelWithOperatorUserIds(java.lang.String name,
                                             java.lang.Object coverUrlOrImage,
                                             java.lang.String data,
                                             java.lang.String customType,
                                             java.util.List<java.lang.String> operatorUserIds,
                                             OpenChannel.OpenChannelUpdateHandler handler)
                                      throws java.lang.ClassCastException

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. Pass String, File or null only, throws exception otherwise.

data - New custom data.

customType - New custom type.

operatorUserIds - New operator IDs.

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.9

updateChannel

public void updateChannel(OpenChannelParams params,
                          OpenChannel.OpenChannelUpdateHandler handler)

Update this channel with OpenChannelParams.

Parameters:

params - Params of channel. Refer to OpenChannelParams.

handler - Callback handler.

Throws:

java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.

Since:

3.0.150

enter

public void enter(OpenChannel.OpenChannelEnterHandler handler)

Enters this channel. The current User becomes a participant of this channel.

Parameters:

handler - Callback handler.

exit

public 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

public ParticipantListQuery createParticipantListQuery()

Creates a query instance to get the whole participant list (online only) of this channel.

Returns:

Query to use.

createMutedUserListQuery

public MutedUserListQuery createMutedUserListQuery()

Creates a query instance to get the muted user (online and offline both) list of this channel.

Returns:

Query to use.

createBannedUserListQuery

public BannedUserListQuery createBannedUserListQuery()

Creates a query instance to get the banned user list from this channel.

Returns:

Query to use.

banUser

public 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

public void banUserWithUserId(java.lang.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

public 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

public void unbanUserWithUserId(java.lang.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

public 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

public void muteUserWithUserId(java.lang.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

public void muteUser(User user,
                     java.lang.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(User, OpenChannelMuteHandler).

Parameters:

user - User to mute.

description - Description.

seconds - Duration for the mute.

handler - Callback handler.

Since:

3.0.79

muteUserWithUserId

public void muteUserWithUserId(java.lang.String userId,
                               java.lang.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(User, OpenChannelMuteHandler).

Parameters:

userId - User ID to mute.

description - Description.

seconds - Duration for the mute.

handler - Callback handler.

Since:

3.0.79

unmuteUser

public 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

public void unmuteUserWithUserId(java.lang.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

public boolean isOperator(User user)

Checks if the given User is an operator of this channel.

Parameters:

user - User to check.

Returns:

true if the User is an operator.

isOperatorWithUserId

public boolean isOperatorWithUserId(java.lang.String userId)

Checks if the given User is an operator of this channel.

Parameters:

userId - User ID to check.

Returns:

true if the User is an operator.

toString

public java.lang.String toString()

Overrides:

toString in class BaseChannel

clone

public static OpenChannel clone(OpenChannel channel)

Clones and returns a new instance of given OpenChannel

Parameters:

channel - OpenChannel to clone

Returns:

a cloned new instance of this OpenChannel

Since:

3.0.125