Open
Represents an open channel.
Properties
All locally cached metadata as a map. Cached metadata is updated under following circumstances:
The custom type of the channel. You can set custom type of this channel by createChannel or updateChannel.
Whether the channel is ephemeral.
Whether the instance is FeedChannel type.
Whether the instance is GroupChannel type.
Whether the instance is OpenChannel type.
The local timestamp of when this channel has been used in a MessageCollection.
The total number of participants in this channel.
Functions
Adds message meta array values.
Add operators to the channel. See [
Adds an option with optionText to this poll. Once added successfully, a non-null Poll instance will be passed to the PollHandler.
Adds Reaction.
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.
Cancels an ongoing FileMessage upload.
Copies a file message from this channel to the target channel.
Copies a user message from this channel to the target channel.
Creates a query instance to get the banned user list from this channel.
Creates message meta array keys.
Creates meta counters. This can be used to customize the channel.
Creates meta data. This can be used to customize the channel.
Creates a query instance to get the muted user (online and offline both) list of this channel.
Creates a query instance to get the operator list from this channel.
Creates a query instance to get the whole participant list (online only) of this channel.
Creates a query instance to get the poll list from this channel.
Creates a query instance to get the voters of a poll option.
Creates previous message list query for this channel.
Decreases meta counters. This decreases atomically the keyed meta counter by the specified value.
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.
Deletes all meta counters.
Deletes all meta data.
Deletes a message.
Deletes a message with message ID. To delete message in OpenChannel with ephemeral mode, use deleteMessage with BaseMessage object instead.
Deletes message meta array keys.
Deletes a meta counter.
Deletes a meta data.
Deletes this poll. Once deleted successfully, a null will be passed to the handler as the error.
Deletes this poll option. Once deleted successfully, a null will be passed to the handler as error.
Deletes Reaction.
Enters this channel. The current User becomes a participant of this channel.
Exits from this channel. The current User is no longer a participant of this channel.
Get all meta counters.
Gets all meta data.
Requests message change logs after given timestamp. The result is passed to handler.
Requests message change logs after given token. The result is passed to handler.
Retrieves previous or next messages based on the message ID in a specific channel. The result is passed to handler as list.
Retrieves previous or next messages based on the timestamp in a specific channel. The result is passed to handler as list.
Gets meta counters.
Gets meta data.
Gets my muted information in this channel.
Requests poll change logs after given timestamp. The result is passed to handler.
Requests poll change logs after given token. The result is passed to handler.
Increases meta counters. This increases atomically the keyed meta counter by the specified value.
Checks if the given User is an operator of this channel.
Mutes User. Muted User's messages are no longer delivered to current User.
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.
Refreshes all the data of this channel.
Remove all operators from the channel. See https://docs.sendbird.com/platform/user_type#3_operator for the explanations on the operators.
Removes message meta array values.
Remove operators from the channel. See [
Reports this channel of inappropriate activities.
Reports a malicious message.
Reports a user of suspicious activities.
Resends a file with given file information.
Resends a file with given file information and gets callback for uploading progress.
Resends a failed user message.
Resends a file with given file information.
Resends a file with given file information and gets callback for uploading progress.
Resends a failed user message.
Sends a file with given file information.
Sends a file with given file information and gets callback for uploading progress.
Sends files with given files information. The maximum number of files is 20.
Sends files with given files information and gets callback for uploading progress. The maximum number of files is 20. This method handles FileMessageCreateParams only which have set binary file not URL.
Sends a user message.
Serializes the GroupChannel or OpenChannel instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData.
Translates a user message.
Unbans User. Operators can unban User who has been banned from this channel.
Unmutes User. Unmuted User's messages are again shown to current User.
Update this channel with OpenChannelParams.
Updates a FileMessage that was previously sent in the channel. Note that the file itself cannot be changed; only the fields stored within the message can be modified.
Updates meta counters.
Updates meta data.
Updates optionText fields of this poll option. Once updated successfully, a non-null PollOption instance will be passed to the handler.
Updates a UserMessage that was previously sent in the channel.
Vote on pollOptionIds. This operation overrides previous vote actions, so to update previous vote, pass new pollOptionIds as parameter. To cancel votes, pass an empty list as pollOptionIds.