GroupChannel

The push trigger option. Refer to setMyPushTriggerOption.

All locally cached metadata as a map. Cached metadata is updated under following circumstances:

The cover image URL.

The creation time of the channel in milliseconds.

The creator of this channel.

The custom type of the channel. You can set custom type of this channel by createChannel or updateChannel.

The channel data.

Indicates whether this channel includes any AI bots.

Indicates whether this channel includes any bots

The HiddenState of this channel.

My invitation timestamp.

The inviter of the current User to this channel.

Whether this channel requires access code to join. This value is valid only if this channel is a public GroupChannel.

Checks whether this channel is a broadcast GroupChannel.

Checks whether this channel is a chat notification GroupChannel.

Checks whether this channel is discoverable in the result of PublicGroupChannelListQuery. If it is false, it will not appear on the result of PublicGroupChannelListQuery.

Checks whether this channel is a distinct GroupChannel. For a distinct GroupChannel, later when you create GroupChannel with same User and isDistinct flag being true (refer to createChannel), the channel URL does not change, which means the messages between Users remain at the channel. If the channel is not distinct one, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.

Whether the channel is ephemeral.

Checks whether this channel is an exclusive GroupChannel.

Whether the instance is FeedChannel type.

Whether the channel is frozen.

Whether the instance is GroupChannel type.

Checks whether this channel is hidden.

Whether the instance is OpenChannel type.

Checks whether this channel is a public GroupChannel.

Checks whether this channel is a super GroupChannel.

Weather the template label is enabled or not.

Whether one or more members are typing.

The timestamp when the current user joined.

The total joined member count for this channel.

The last message of the channel.

The last message among channel's pinned messages.

The total member count for this channel.

Member list for this channel.

The local timestamp of when this channel has been used in a MessageCollection.

This property is set when resetMyHistory and hide is called.

Checks whether unread message count is enabled for this channel. This count preference can be set by setMyCountPreference.

Current user's last read receipt timestamp in channel.

My member state.

My muted state in this channel.

My push trigger option. The push trigger setting can be updated by setMyPushTriggerOption.

My Role in this channel.

The topic or name of the channel.

The pinned message ids of the channel.

The typing user list.

The unread mention count for this channel for the current User.

The unread message count for this channel for the current User.

The unique channel URL.

Accepts the invitation sent to the current User. After the acceptance, the User will be joined to this GroupChannel.

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 member. Operators can ban members from this channel. Banned member 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.

Cancels a scheduled message with scheduledMessageId.

Closes this poll. Once closed successfully, a non-null Poll instance will be passed to the handler.

Copies a file message from this channel to the target channel.

This is a function that copies a MultipleFilesMessage to another 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 a query instance to get members.

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 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.

Creates a file message to be sent at the specified time.

Creates a user message to be sent at the specified time.

Declines the invitation sent to the current User.

Decreases meta counters. This decreases atomically the keyed meta counter by the specified value.

Deletes this GroupChannel. 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.

Sends end typing event.

Freeze this GroupChannel.

Get all meta counters.

Gets all meta data.

Gets delivered time for all members in this GroupChannel.

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.

Gets push trigger option of this channel. Refer to GroupChannel.PushTriggerOption. For details of push trigger option, refer to setMyPushTriggerOption

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.

Gets the member list who have read the given message.

Gets ReadStatus for all members in this GroupChannel.

Returns the number of member's that haven't received the given message. This excludes the current logged-in User and the Sender of the message. It will always be zero if the passed on message is an AdminMessage, or if this channel is a super group channel.

Returns the number of member's that haven't read the given message. This excludes the current logged-in User and the Sender of the message. It will always be zero if the passed on message is an AdminMessage, or if this channel is a super group channel.

Gets the member list who haven't read the given message.

Hides this channel from the current User's GroupChannel` list. When a new message is received from the channel, it appears again.

Hides this channel from the current User's GroupChannel list. When a new message is received from the channel, it appears again.

Hides this channel from the current User's GroupChannel list.

Increases meta counters. This increases atomically the keyed meta counter by the specified value.

Invites Users top this channel.

Joins this channel if this channel is public.

Leaves this channel.

Sends mark as read to this channel with a CompletionHandler.

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.

Pins a message to the channel.

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.

Reports this channel of inappropriate activities.

Resends a file with given file information.

Resends a file with given file information and gets callback for uploading progress.

Resends a file message. File information is used from the failed message.

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 multiple files or file URLs as a single MultipleFilesMessage.

Resends a failed user message.

Resets the chat history of this channel for the current User. After this call, the messages created before the call will not be loaded.

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.

This is a function that sends multiple files or file URLs as a single MultipleFilesMessage.

Sends a scheduled message now.

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.

Sets my count preference for this channel.

Sets push trigger option of this channel. If channel's push trigger option is set to GroupChannel.PushTriggerOption.DEFAULT, it works according to the state of SendbirdChat.PushTriggerOption. If not, push messages will be triggered according to the state of GroupChannel.PushTriggerOption.

Sends start typing event.

Translates a user message.

Unbans User. Operators can unban User who has been banned from this channel.

Unfreeze this GroupChannel.

Unhides this channel from the current User's GroupChannel list.

Unmutes User. Unmuted User's messages are again shown to current User.

Removes the message from the channel's pinned messages.

Update this channel with GroupChannelUpdateParams.

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 fields of this poll with given params. Once updated successfully, a non-null Poll instance will be passed to the handler.

Updates optionText fields of this poll option. Once updated successfully, a non-null PollOption instance will be passed to the handler.

Update a scheduled file message with scheduledMessageId and ScheduledFileMessageUpdateParams.

Update a scheduled user message with scheduledMessageId and ScheduledUserMessageUpdateParams.

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.