Group channel
A group channel is a chat that allows close interactions among a limited number of users. It can be private or public. A private group channel can let a user join the chat through an invitation by another user who is already a member of the chatroom. For 1-on-1 messaging, you can create a private group channel with two members. A public group chat can let a user join the chat without invitation from others. A group channel can consist of one to one hundred members by default setting. This default number of members can increase per request.
A user can receive all messages from the group channels that they are a member of, and sends a message to those channels. They can also receive push notifications, typing indicators, unread counts and read receipts from the joined channels when they go offline. For more information, see the Push notifications page which describes how to turn on and manage the push preference.
Note: To learn about differences between open channels and group channels, see Channel types.
Choose a type of a channel
With our Chat SDK for Android, you can use a variety of behavior related properties when creating different types of group channels. You can create a group channel after configuring these properties.
Private vs. Public
A private group channel can be joined only by users that have accepted an invitation from an existing channel member by default. On the other hand, a public group channel can be joined by any user without an invitation, like an open channel.
A private channel can be used for 1-on-1 conversations, such as clinical consultations and Instagram-style Direct Messages, while a public channel for 1-to-N conversations, such as small group discussions among students.
1-to-1 vs. 1-to-N
The distinct
property determines whether to resume an old channel or to create a new one when someone attempts to open a channel with the same members. For a 1-to-1 chat, it is highly recommended that you turn on the distinct
property to continuously use the existing channel.
Let's say there is a distinct group channel with user A, B, and C. If you attempt to create a new channel with the same members, the existing channel will be used. This is similar to Twitter-style 1-to-1 direct messaging. If the distinct
property of the channel is set to false, a new channel will be created.
Note: The default value of this property is false. When a new member is invited or an existing member leaves the channel, then the
distinct
property of the channel is automatically turned off as well.
Supergroup vs. Group
For occasions that demand engagement among a high volume of members, you can create a Supergroup channel, an expanded version of a group channel. It can be used for midsize conferences or large group discussion, such as company-wide stand-ups.
When the super
property is set to true, a Supergroup channel will be created and up to tens of thousands of members can gather in the channel. The maximum number of members for a Supergroup channel can be adjusted depending on your Chat subscription plan.
Note: When
super
is set to true,distinct
can't be supported.
Ephemeral vs. Persistent
Messages sent in an ephemeral group channel are not saved in Sendbird's database. As such, old messages that are pushed out of a user's chat view due to new messages can't be retrieved. On the other hand, messages sent in a persistent group channel are stored permanently in the database by default.
Create a channel
A user can create a group channel from inviting other users anytime in their client app. At the implementation level, you just need to write your code which passes the IDs of users to invite as an argument to a parameter in the creation method.
Before you write the code for creating a group channel for a typical 1-on-1 chat, you should make sure that you turn on the distinct
property of the channel. Otherwise, if you turn off the distinct
property, a new channel will be created with the same partner user even if there is already an existing channel between them. In this case, multiple 1-on-1 channels between the same two users can exist, each with its own chat history and data.
However, if you plan to create a Supergroup channel, the distinct
property should be set to false.
Note: If you want to retrieve a list of group channels, which also includes the current user's empty channels without any chat, you should set the
includeEmptyChannel
option to true through thesetIncludeEmptyChannel()
method of aGroupChannelListQuery
instance for the retrieval.
When creating a channel, you can also append additional information like cover image and description by passing several arguments to the corresponding parameters.
List of arguments
Argument | Type | Description |
---|---|---|
| list | Specifies a list of one or more users to invite to the channel. |
| boolean | Determines whether to reuse an existing channel or create a new channel. If set to true, returns a channel with the same users in the |
| boolean | Determines whether a new channel will be a Supergroup channel or a group channel. If set to true, the new channel can accommodate more than 2,000 members. When this argument is true, |
| string | Specifies the channel topic, or the name of the channel. |
| object | Specifies the cover image URL of the channel, or uploads a file for the cover image. |
| string | Specifies additional channel information such as a long description of the channel or |
| string | Specifies the custom channel type which is used for channel grouping. |
| interface | Specifies the |
Using the getCoverUrl()
and updateChannel()
methods, you can get and update the cover image URL of a channel.
Note: You can also create a group channel using the Chat API which helps you control channel creations and member invitations on your server-side.
Otherwise, you can configure GroupChannelParams
and create a new channel with that like below.
Note: By default, the Allow creating group channels option is turned on which means that group channels can be created by any user with Sendbird Chat SDK. This may grant access to unwanted data or operations, leading to potential security concerns. To manage your access control settings, you can turn on or off each option in Settings > Application > Security > Access control list on Sendbird Dashboard.
Invite users as members
Only members of a group channel can invite new users into the channel. You can also determine whether the newly invited user sees the past messages in the channel or not.
Note: In your dashboard, go to the Settings > Chat > Channels > Group channels, and there is the
Chat history
option. If the option is turned on, new users can view all messages sent before they have joined the channel. If turned off, new users only see messages sent after they have been invited. By default, this option is turned on.
Accept or decline an invitation from another user
A user who is invited to a group channel can accept or decline the invitation. If a user accepts an invitation, they join the channel as a new member and can start chatting with other members. Otherwise, the invitation will be canceled if a user declines it. Since a user is allowed to join up to 2,000 group channels, the invitation to a user who already belongs to a maximum number of group channels will be canceled automatically.
By implementing the onUserReceivedInvitation()
and onUserDeclinedInvitation()
of a channel event handler, you can make the client apps of other members in the foreground to be notified of the results of two actions above. For more information, see the Event handler page.
Note: Using the
setChannelInvitationPreference()
, you can determine for users within an application whether or not to automatically join a private group channel promptly from an invitation without having to accept it. By default, the value of channel invitation preference is true. If you want to give them the option to decide whether to accept or decline an invitation, you should set the preference's value to false via thesetChannelInvitationPreference()
like the following sample code.
Join a channel as a member
This is only for public group channels. Any user can join a public group channel as a member without an invitation and chat with other members in the channel. Since a user is allowed to join up to 2,000 group channels, a user who already belongs to a maximum number of group channels can't join a new channel.
Leave a channel
A user can leave group channels as shown below. After leaving, the user can't receive messages from the channel, and this method can't be called for deactivated users.
Freeze and unfreeze a channel
You can temporarily disable various functions of a group channel to stop members from chatting in the channel, and enable the functions so that the members chat with each other. Note that in a frozen channel, normal members can't chat with each other but the operators can send a message to the channel.
Delete a channel
Only the operators of a group channel can delete the channel. Otherwise, an error is returned through the GroupChannelDeleteHandler
.
Note: The following code works properly in the operators' client apps only.
Retrieve a list of channels
You can get a list of the current user's private group channels using the GroupChannelListQuery
instance's next()
method, which returns a list of GroupChannel
objects.
Note: Using the
setIncludeEmpty()
method of aGroupChannelListQuery
instance, you can determine whether to include empty channels in the result. Empty channels are group channels that have been created but do not contain any messages, and are not included by default. However, if you turn off theChat history
option in your dashboard, you may retrieve empty channels in the result.
You can also get a list of the current user's public group channels using the PublicGroupChannelListQuery
instance's next()
method, which returns a list of GroupChannel
objects.
Note: Using the
setIncludeEmpty()
method of aPublicGroupChannelListQuery
instance, you can determine whether to include empty channels in the result. Empty channels are group channels that have been created but do not contain any messages, and are not included by default. However, if you turn off theChat history
option in your dashboard, you may retrieve empty channels in the result.
Note: Refer to this section in the Advanced page for information on how to search for specific group channels with keywords and filters.
Retrieve a channel by URL
Since a channel URL is a unique identifier of a group channel, you can use a URL when retrieving a channel object.
Note: We recommend that you store a user's channel URLs to handle the lifecycle or state changes of your client app, or other unexpected situations. For example, when a user is disconnected from Sendbird server due to switching to another app temporarily, you can provide a smooth restoration of the user's state using a stored URL to fetch the appropriate channel instance.
Hide or archive a channel from a list of channels
The following code will allow you to hide or archive a specific group channel from a list of the channels.
List of arguments
Argument | Type | Description |
---|---|---|
| boolean | When the channel gets appeared back in the list, determines whether to conceal the messages sent and received before hiding or archiving the channel. If set to true, the previous messages aren't displayed in the channel. (Default: false) |
| boolean | Determines the state and operating behavior of the channel in the list. If set to true, the channel is hidden from the list, automatically gets unhidden when receiving a new message from other members of the channel, and appears back. If set to false, the channel is archived and disappeared from the list, and never appears back unless the |
Using the getHiddenState()
, you can check the channel state with regard to the list.
You can also filter channels by their state like the following:
Filter channels by user IDs
To filter channels by user IDs, use the userIdsExactFilter
or userIdsIncludeFilter
. Let's assume the ID of the current user is Harry and the user is a member of two group channels:
- channelA consists of Harry, John, and Jay.
- channelB consists of Harry, John, Jay, and Jin.
A userIdsExactFilter
returns a list of the current user's group channels containing exactly the queried user IDs. In case you specify only one user ID in the filter, the filter returns a list of the current user's one distinct or more 1-to-1 group channels with the specified user.
A userIdsIncludeFilter
returns a list of the current user's group channels including the queried user IDs partially and exactly. Two different results can be returned according to the value of the queryType
parameter.
Send a message
In a group channel, users can send messages of the following types:
Message type | Class | Description |
---|---|---|
Text | A text message sent by a user | |
File | A binary file message sent by a user |
In addition to these message types, you can further subclassify a message by specifying its custom type. This custom type takes on the form of a String
and can be used to search or filter messages. It allows you to append information to your message and customize message categorization.
The following code shows several types of parameters that you can configure to customize text messages by using UserMessageParams
. Under the UserMessageParams
object, you can assign specific values to message
, data
and other properties. By assigning arbitrary string to the data
property, you can set custom font size, font type or JSON
object. To send your messages, you need to pass the UserMessageParams
object as an argument to the parameter in the sendUserMessage()
method.
Through the onSent()
callback method of the sendUserMessage()
method, Sendbird server always notifies whether your message has been successfully sent to the channel. When there is a delivery failure due to network issues, an exception is returned through the callback method.
A user can also send binary files through the Chat SDK. The two ways to send a binary file are: sending the file itself, or sending a URL.
Sending a raw file means you're uploading it to Sendbird server where it can be downloaded in client apps. When you upload a file directly to the server, there is a size limit imposed on the file depending on your plan. You can see the limit in your dashboard and adjust it with our sales team.
The other option is to send a file hosted on your server. You can pass the file's URL, which represents its location, as an argument to a parameter. In this case, your file is not hosted on Sendbird server and it can only be downloaded from your own server. When you send a file message with a URL, there is no limit on the file size since it's not directly uploaded to Sendbird server.
Note: You can use
sendFileMessages()
, which is another method that allows you to send up to 20 file messages per one method call. Refer to our API Reference to learn more about it.
The following code shows several types of parameters that you can configure to customize file messages by using FileMessageParams
. Under the FileMessageParams
object, you can assign specific values to customType
and other properties. To send your messages, you need to pass the FileMessageParams
object as an argument to the parameter in the sendFileMessage()
method.
Through the onSent()
callback method of the sendFileMessage()
method, Sendbird server always notifies whether your message has been successfully sent to the channel. When there is a delivery failure due to network issues, an exception is returned through the callback method.
Send a critical alert message to iOS devices
A critical alert is a notification that can be sent to iOS devices even when mute or Do Not Disturb is turned on. Critical alert messages can be sent to iOS devices through the sendUserMessage()
and sendFileMessage()
methods. To do so, create an AppleCriticalAlertOptions
instance and set it as an attribute of a UserMessageParams
instance. Then pass the created UserMessageParams
instance as an argument to a parameter in the sendUserMessage()
or sendFileMessage()
method.
Note: To learn more about how to set critical alerts, visit Apple critical alerts.
Receive messages through a channel event handler
Messages sent from other members can be received through the onMessageReceived()
method of a channel event handler. A BaseMessage
object for each received message is one of the following three message types.
Message type | Class | Description |
---|---|---|
Text | A text message sent by a user | |
File | A binary file message sent by a user | |
Admin | A text message sent by an admin through the Chat API |
UNIQUE_HANDLER_ID
is a unique identifier to register multiple concurrent handlers.
If the UI isn't valid anymore, remove the channel event handler.
Reply to a message
You can reply to a specific message in a channel through the sendUserMessage()
or sendFileMessage()
method. To do so, you should create a UserMessageParams
or a FileMessageParams
object and then specify the parentMessageId
property of the object. Sending reply messages works the same way as sending regular messages to a channel except replies have an additional parentMessageId
property.
Reply with a text message
When replying to a message through the sendUserMessage()
method, specify and pass a UserMessageParams
object as an argument to a parameter in the method.
List of arguments
Argument | Type | Description |
---|---|---|
| long | Specifies the unique ID of a parent message. A parent message is a message that has a thread of replies. If the message sent through the |
Reply with a file message
When replying with a file message through the sendFileMessage()
method, you should specify and pass a FileMessageParams
object as an argument to a parameter in the method.
List of arguments
Argument | Type | Description |
---|---|---|
| long | Specifies the unique ID of a parent message. A parent message is a message that has a thread of replies. If the message sent through the |
Mention other members in a message
When a member wants to call the attention of other members of a group channel, they can mention those members in a message. To do so, you should:
-
Specify a list of the user IDs to mention.
-
Add the list to either
UserMessageParams
orFileMessageParams
which may contain options for further action. -
Pass the params to either
sendUserMessage()
orsendFileMessage()
. -
Up to 10 members mentioned in the message will be notified.
React to a message
Message reactions will help you build a more engaging chat experience that goes beyond text messages. They are a quick and easy way for users to respond to a message. Users can express their acknowledgement of or feelings about a message without written text by simply adding reactions. They can also view and delete their reactions to the message.
Note: Currently, message reactions are only available in group channels.
You can decide how to display reactions that were added to messages in the current user’s chat view.
Note:
getPreviousMessagesByTimestamp()
,getNextMessagesByTimestamp()
,getPreviousAndNextMessagesByTimestamp()
are deprecated. Accordingly, use thegetMessagesByTimestamp()
method instead.
Note: Messages along with their reactions can also be retrieved by using the
PreviousMessageListQuery
'sload()
method. To learn more, refer to the Load previous messages section below.
If one of the channel members reacts to a message, the onReactionUpdated()
method in the channel event handler will be invoked on all channel members’ devices including the one that made the reaction. The applyReactionEvent()
method will reflect the reaction change to the message in real time.
Load previous messages
Using the PreviousMessageListQuery
's load()
method which returns a list of BaseMessage
objects, you can retrieve a set number of previous messages in a group channel. With a returned list, you can display the past messages in your UI once they have loaded.
Note: You can decide whether a user can see the messages sent prior to the user joining a group channel. In your dashboard, go to the Settings > Chat > Channels > Group channels, there is the
Chat history
option. If turned on, new users are allowed to view a message history in joined group channels. If turned off, new users aren't allowed to see the messages prior to joining a group channel.
List of arguments
Argument | Type | Description |
---|---|---|
| int | Specifies the number of results to return per call. Acceptable values are 1 to 100, inclusive. The recommended value for this parameter is 30. |
| boolean | Determines whether to sort the retrieved messages in reverse order. If true, returns a list of messages which the latest comes at first and the earliest at last. the results are sorted in reverse order. If false, returns a list of messages which the earliest comes at first and the latest at last. |
A LIMIT
parameter indicates how many messages should be included in a returned list. A PreviousMessageListQuery
instance itself does pagination of a result set based on the value of the LIMIT
parameter, and internally manages a token to retrieve the next page in the result set.
Each time the load()
method is called, the instance retrieves a set number of messages in the next page and updates the value of the token to complete the current call and prepare a next call.
If you create a new PreviousMessageListQuery
instance and call the load()
method, a set number of the most recent messages are retrieved because its token has nothing to do with the previously created instance. So we recommend that you create a single query instance and store it as a member variable for traversing through the entire message history.
Note: Before invoking the
load()
method again, you must receive youronResult()
callback first.
The following table shows all the supported filters for PreviousMessageListQuery
to search for messages you want to retrieve. You can use any filters in a similar fashion with the sample code above.
List of filters
Name | Filters... |
---|---|
MessageTypeFilter | Messages with the specified message type. The |
CustomTypeFilter | Messages with the specified custom type. The |
SenderUserIdsFilter | Messages that are sent by the specified users. The |
Load messages by timestamp or message ID
Using the getMessagesByTimestamp()
method, you can retrieve a set number of previous and next messages on both sides of a specific timestamp in a group channel.
The following code shows several types of parameters that you can configure to customize a message query by using MessageListParams
. Under the MessageListParams
object, you can assign values to previousResultSize
, messageType
, customType
, and other properties. To retrieve messages in a channel, you need to pass the MessageListParams
object as an argument to the parameter in the getMessagesByTimestamp()
method.
List of arguments
Argument | Type | Description |
---|---|---|
| long | Specifies the timestamp to be the reference point of a retrieval, in Unix milliseconds. |
| boolean | Determines whether to include the messages sent exactly on the |
| int | Specifies the number of messages to retrieve, which are sent previously before a specified timestamp. Note that the actual number of results may be larger than the set value when there are multiple messages with the same timestamp as the earliest message. |
| int | Specifies the number of messages to retrieve, which are sent later after a specified timestamp. Note that the actual number of results may be larger than the set value when there are multiple messages with the same timestamp as the latest message. |
| boolean | Determines whether to sort the retrieved messages in reverse order. |
| enum | Specifies the message type to filter the messages with the corresponding type. Acceptable values are MessageTypeFilter.ALL, MessageTypeFilter.USER, MessageTypeFilter.FILE, and MessageTypeFilter.ADMIN. |
| string | Specifies the custom message type to filter the messages with the corresponding custom type. |
You can also retrieve a set number of previous and next messages on both sides of a specific message ID in a group channel, using the getMessagesByMessageId()
method and MessageListParams
object.
List of arguments
Argument | Type | Description |
---|---|---|
| long | Specifies the unique ID of the message to be the reference point of a retrieval. |
| boolean | Determines whether to include the message identified with a specified message ID. |
| int | Specifies the number of messages to retrieve, which are sent previously before a specified message ID. |
| int | Specifies the number of messages to retrieve, which are sent later after a specified timestamp. |
| boolean | Determines whether to sort the retrieved messages in reverse order. |
| enum | Specifies the message type to filter the messages with the corresponding type. Acceptable values are MessageTypeFilter.ALL, MessageTypeFilter.USER, MessageTypeFilter.FILE, and MessageTypeFilter.ADMIN. |
| string | Specifies the custom message type to filter the messages with the corresponding custom type. |
List messages along with their replies
You can retrieve messages and their replies in a specific thread through one of the load()
, getMessagesByTimestamp()
, or getMessagesByMessageId()
methods.
Load channel messages
The load()
method of a PreviousMessageListQuery
instance returns a list of BaseMessage
objects. By using this method, you can retrieve previous messages in a specific channel.
List of arguments
Argument | Type | Description |
---|---|---|
| int | Specifies the number of results to return per call. Acceptable values are 1 to 100, inclusive. The recommended value for this parameter is 30. |
| boolean | Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order. |
| boolean | Determines whether to include the information of the message thread in the results that contain parent messages. |
| enum | Specifies the type of message to include in the results. |
| boolean | Determines whether to include the information of the parent messages in the result. (Default: false) |
| boolean | (Deprecated) Determines whether to include replies in the results. |
| boolean | (Deprecated) Determines whether to include the parent message text in the results when the retrieved messages are replies in a thread. If the type of the parent message is |
Load messages by timestamp or message ID
The getMessagesByTimestamp()
and getMessagesByMessageId()
methods of a BaseChannel
instance returns a list of BaseMessage
objects.
When using either of the methods above, you can also pass a MessageListParams
object as an argument to the parameter in those methods.
List of arguments
Argument | Type | Description |
---|---|---|
| int | Specifies the number of messages to retrieve that were sent before the specified timestamp or message ID. |
| int | Specifies the number of messages to retrieve that were sent after the specified timestamp or message ID. |
| boolean | Determines whether to include the messages with the matching timestamp or message ID in the results. |
| boolean | Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order. |
| boolean | Determines whether to include the information of the message thread in the results that contain parent messages. |
| enum | Specifies the type of message to include in the results. |
| boolean | Determines whether to include the information of the parent messages in the result. (Default: false) |
| boolean | (Deprecated) Determines whether to include replies in the results. |
| boolean | (Deprecated) Determines whether to include the parent message text in the results when the messages are replies in a thread. If the type of the parent message is |
By timestamp
The getMessagesByTimestamp()
method retrieves a set number of previous and next messages on both sides of a specific timestamp in a channel.
List of arguments
Argument | Type | Description |
---|---|---|
| long | Specifies the timestamp to be the reference point for messages to retrieve, in Unix milliseconds format. Messages sent before or after the timestamp can be retrieved. |
By message ID
The getMessagesByMessageId()
method retrieves a set number of previous and next messages on both sides of a specific message ID in a channel.
List of arguments
Argument | Type | Description |
---|---|---|
| long | Specifies the message ID to be the reference point for messages to retrieve. Messages sent before or after the message with the matching message ID can be retrieved. |
List replies of a parent message
You can retrieve replies of a parent message if you can determine the parent message like the following. First, create a ThreadMessageListParams
object and set properties related to the thread where the target replies belong to. Then pass the params into the getThreadedMessagesByTimestamp()
method.
List of arguments
Argument | Type | Description |
---|---|---|
| long long | Specifies the timestamp to be the reference point of the retrieval, in Unix milliseconds format. |
| int | Specifies the number of messages to retrieve that were sent before the specified timestamp. |
| int | Specifies the number of messages to retrieve that were sent after the specified timestamp. |
| boolean | Determines whether to include the messages with the matching timestamp in the results. |
| boolean | Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order. |
| boolean | Determines whether to include the information of the parent messages in the result. (Default: false) |
| boolean | (Deprecated) Determines whether to include the parent message text in the results when the messages are replies in a thread. If the type of the parent message is |
Retrieve a message
You can retrieve a specific message by creating and passing the MessageRetrievalParams
object into the getMessage()
method as a parameter.
List of arguments
Argument | Type | Description |
---|---|---|
| String | Specifies the URL of the channel to retrieve the message. |
| BaseChannel.ChannelType | Specifies the type of the channel. |
| long | Specifies the unique ID of the message to retrieve. |
Update a message
A user can update any of their own text and file messages sent. An error is returned if a user attempts to update another user's messages. In addition, channel operators can update any messages sent in a channel.
If a message is updated, the onMessageUpdated()
method in the channel event handler will be invoked on all channel members' devices except the one that updated the message.
Delete a message
A user can delete their own messages. An error is returned if a user attempts to delete messages sent by others. Also operators of a channel can delete any messages in a channel.
If a message is deleted, the onMessageDeleted()
method in the channel event handler will be invoked on all channel members' devices including the one that deleted the message.
Copy a message
A user can copy and send their own message in the same channel or to another channel.
List of arguments
Argument | Type | Description |
---|---|---|
| object | Specifies a target channel to send a copied message to. |
| object | Specifies a message to copy. |
| interface | Specifies the handler interface which contains the |
Clear the chat history
By using the resetMyHistory()
method, you can help the current user clear the chat history in a group channel and start a fresh conversation with other members in the same channel. As the method's name implies, the chat history will be cleared only from the channel view of the current user, and will no longer be shown in that view. But the messages are not deleted from the database of the Sendbird system, and other members can still see all the messages in their channel views.
This method simply clears the messages for the user by updating the lastMessage
and readReceipt
properties of a group channel object in addition to other internally managed data such as the number of the user’s unread message.
When a user is online, all data associated with the group channels they are a member of are automatically updated. However, when a user is disconnected from Sendbird server and reconnects later, you should call the refresh()
method to update the user's group channels with the latest information.
Note: If you want to make your users see the channels updated to the most recent when their client apps are in the foreground, we recommend you call the
refresh()
within theonReconnectSucceeded()
method which receives a callback from Sendbird server when successfully reconnected.
Retrieve a list of all members
You can retrieve a list of all members in a group channel using the getMembers()
method.
Members of a group channel are automatically updated when a user is online. But when a user is disconnected from Sendbird server and then reconnected, you should call the refresh()
method to update the user's group channels with the latest information. See the Refresh all data related to a group channel section for the sample code.
Retrieve the online status of members
To stay updated on each member's connection status in a group channel, call the refresh()
method before calling the getMembers()
method to retrieve the members of the channel.
By calling the user.getConnectionStatus()
method at each user object in a list which the getMembers()
returns, you can retrieve the user's current connection status. The getConnectionStatus()
returns one of the following two values:
getConnectionStatus()
Value | Description |
---|---|
User.ConnectionStatus.OFFLINE | The user is not connected to Sendbird server. |
User.ConnectionStatus.ONLINE | The user is connected to Sendbird server. |
Note: If your client app needs to keep track of the connection status of users in real time, we recommend that you call periodically the
next()
method of anApplicationUserListQuery
instance with itsuserIdsFilter
filter specified, perhaps in intervals of one minute or more.
Retrieve a list of members and operators in a specific order
Using the next()
method of a GroupChannelMemberListQuery
instance, the members and operators of a group channel can be retrieved. For a specific order, set one of the options in the following table to the setOrder()
method of GroupChannelMemberListQuery
.
GroupChannelMemberListQuery.Order
Value | Description |
---|---|
MEMBER_NICKNAME_ALPHABETICAL | The members are arranged in an alphabetical order (Default). |
OPERATOR_THEN_MEMBER_ALPHABETICAL | The operators are sequenced before the members, both in an alphabetical order. |
GroupChannelMemberListQuery.OperatorFilter
For filtering, set one of the options in the following table to the GroupChannelMemberListQuery
's setOperatorFilter()
method.
Value | Description |
---|---|
ALL | No filter is applied to the group channel list (Default). |
OPERATOR | Only operators are retrieved for the list. |
NONOPERATOR | Members, except for operators, are retrieved for the list. |
Retrieve a list of operators
You can get a list of operators who monitor and control the activities in a group channel by using the next()
method of an OperatorListQuery
instance which returns a list of User
objects.
Register operators
You can register members as operators of a group channel.
Cancel the registration of operators
You can cancel the registration of operators from a group channel but leave them as members.
If you want to cancel the registration of all operators in a channel at once, use the following code.
Retrieve a list of banned or muted users
You can create a query to get a list of banned or muted users in a group channel. This query is only available for users who are registered as operators of a group channel.
Ban and unban a user
Operators of a group channel can remove any users that behave inappropriately in the channel by using our Ban feature. Banned users are immediately expelled from a channel and allowed to join the channel again after the time period set by the operators. The operators can ban and unban users from group channels using the following code.
Note: You can also use
banUserWithUserId()
andunbanUserWithUserID()
methods, instead ofbanUser()
andunbanUser()
methods, as they have the same functionalities.
Mute and unmute a user
Operators of a group channel can prohibit the selected users from sending messages using our Mute feature. Muted users remain in the channel and are allowed to view the messages, but can't send any messages until the operators unmute them. The operators can mute and unmute users in group channels using the following code:
Note: You can also use
muteUserWithUserId()
andunmuteUserWithUserID()
methods, instead ofmuteUser()
andunmuteUser()
methods, as they have the same functionalities.
Report a message, a user, or a channel
In a group channel, a user can report suspicious or harassing messages as well as the other users who use abusive language. The user can also report channels if there are any inappropriate content or activity within the channel. Based on this feature and our report API, you can build your own in-app system for managing objectionable content and subject.
List of arguments
Argument | Type | Description |
---|---|---|
| object | Specifies the message to report for its suspicious, harassing, or inappropriate content. |
| object | Specifies the user who uses offensive or abusive language such as sending explicit messages or inappropriate comments. |
| enum | Specifies a report category which indicates the reason for reporting. Acceptable values are limited to ReportCategory.SUSPICIOUS, ReportCategory.HARASSING, ReportCategory.INAPPROPRIATE, and ReportCategory.SPAM. |
| string | Specifies additional information to include in the report. |