Home
/
Chat
/
JavaScript

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.


Choose a type of a channel

With our Chat SDK for JavaScript, you can use a variety of behaviour 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.

1-on-1 vs. 1-on-N

The distinct option determines whether to resume an old channel or to create an entirely new one when someone attempts to open a new channel with a pre-existing member combination. If there is a group channel with those members, the attempt will re-start the existing channel that has their chat history. For example, when attempting to create a new group channel with 3 users, A, B, and C, if a channel with same users already exists, a reference to the existing channel is just returned to who has attempted the new channel.

Consequently, we recommend that you set the distinct option to true in 1-on-1 messaging channels to reuse the existing channel when a user directly sends a message to another user. If the option is false, a new group channel is created with the same user even if there is a previous chat between them, and you can't see the old messages or data.

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. When the super option is set to true, a Supergroup channel will be created and more than 2,000 members can gather in the channel. The maximum number of members in a Supergroup channel varies by your Sendbird plan.

Note: When the super option is set to true, the distinct option 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 implemention 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 includeEmpty option of MyGroupChannelListQuery instance for the retrieval.

Light Color Skin
Copy
var userIds = ['John', 'Harry'];
// When 'distinct' is false
sb.GroupChannel.createChannelWithUserIds(userIds, false, NAME, COVER_IMAGE_OR_URL, DATA, function(groupChannel, error) {
    if (error) {
        // Handle error.
    }

    // A group channel of the specified users is successfully created.
    // Through the "groupChannel" parameter of the callback function,
    // you can get the group channel's data from the result object that Sendbird server has passed to the callback function.
    const channeUrl = groupChannel.channelUrl;
    ...
});

When creating a channel, you can also append additional information like cover image and description by passing several arguments to the corresponding parameters.

Light Color Skin
Copy
var userIds = ['John', 'Harry'];

sb.GroupChannel.createChannelWithUserIds(userIds, IS_DISTINCT, NAME, COVER_IMAGE_OR_URL, DATA, CUSTOM_TYPE, function(groupChannel, error) {
    if (error) {
        // Handle error.
    }

    // A group channel with additional information is successfully created.
    const channeUrl = groupChannel.channelUrl;
    ...
});
ArgumentTypeDescription

userIds

string[]

Specifies an array of one or more users to invite to the channel.

IS_DISTINCT

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 userIds or creates a new channel if no match is found. Sendbird server can also use the custom channel type in the CUSTOM_TYPE along with the userIds to return the corresponding channel. If set to false, Sendbird server always creates a new channel with a combination of the users as well as the channel custom type if specified.

IS_SUPER

boolean

Determines whethere 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, IS_DISTINCT is not supperted and should be set to false.

NAME

string

Specifies the channel topic, or the name of the channel.

COVER_IMAGE_OR_URL

string or file

Specifies the cover image URL of the channel, or uploads a file for the cover image.

DATA

string

Specifies additional channel information such as a long description of the channel or JSON formatted string.

CUSTOM_TYPE

string

Specifies the custom channel type which is used for channel grouping.

function()

callback

Specifies the callback function which receives the response from Sendbird server for a channel creation request.

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.

Light Color Skin
Copy
var params = new sb.GroupChannelParams();
params.isPublic = false;
params.isEphemeral = false;
params.isDistinct = false;
params.isSuper = false;
params.addUserIds(['John', 'Harry']);
params.operatorUserIds = ['Jay'];   // Or .operators(Array<User>)
params.name = NAME;
params.channelUrl = UNIQUE_CHANNEL_URL; // In a group channel, you can create a new channel by specifying its unique channel URL in a 'GroupChannelParams' object.
params.coverImage = FILE;       // Or .coverUrl = COVER_URL;
params.data = DATA;
params.customType = CUSTOM_TYPE;

sb.GroupChannel.createChannel(params, function(groupChannel, error) {
    if (error) {
        // Handle error.
    }

    // A group channel with detailed configuration is successfully created.
    // By using groupChannel.channelUrl, groupChannel.members, groupChannel.data, groupChannel.customType, and so on,
    // you can access the result object from Sendbird server to check your GroupChannelParams configuration.
    const channeUrl = groupChannel.channelUrl;
    ...
});

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.

Light Color Skin
Copy
var userIds = ['John', 'Harry'];

groupChannel.inviteWithUserIds(userIds, function(response, error) {
    if (error) {
        // Handle error.
    }

    ...
});

Accept or decline an invitation from other 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.

Light Color Skin
Copy
// Accepting an invitation
groupChannel.acceptInvitation(function(response, error) {
    if (error) {
        // Handle error.
    }

    ...
});

// Declining an invitation
groupChannel.declineInvitation(function(response, error) {
    if (error) {
        // Handle error.
    }

    ...
});

By implementing the onUserReceivedInvitation() and onUserDelclinedInvitation() in the 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 the setChannelInvitationPreference() like the following sample code.

Light Color Skin
Copy
var autoAccept = false; // The value of true (default) means that a user will automatically join a group channel with no choice of accepting and declining an invitation.

sb.setChannelInvitationPreference(autoAccept, function(response, error) {
    if (error) {
        // Handle error.
    }

    ...
});

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.

Light Color Skin
Copy
if (groupChannel.isPublic) {
    groupChannel.join(function(response, error) {
        if (error) {
            // Handle error.
        }

        ...
    });
}

Leave a channel

If a user leaves a group channel, the user can't receive messages from the channel anymore.

Light Color Skin
Copy
groupChannel.leave(function(response, error) {
    if (error) {
        // Handle error.
    }

    ...
});

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.

Light Color Skin
Copy
// Freezing a channel
groupChannel.freeze(function(response, error) {
    if (error) {
        // Handle error.
    }

    // The channel successfully gets frozen.
    // You could display a message telling that chatting in the channel is unavailable, or do something in response to a successfull operation.
    ...
});

// Unfreezing a channel
groupChannel.unfreeze(function(response, error) {
    if (error) {
        // Handle error.
    }

    // The channel successfully gets unfrozen.
    // You could display a message telling that chatting in the channel is available again, or do something in response to a successful operation.
    ...
});

Retrieve a list of channels

After creating a GroupChannelListQuery instance from the createMyGroupChannelListQuery() and using the instance's next() method, which returns a list of group channel objects, you can get a list of the current user's private group channels.

Note: Using the includeEmpty option of a GroupChannelListQuery 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 the Chat history option in your dashboard, you may retrieve empty channels in the result.

Light Color Skin
Copy
var listQuery = sb.GroupChannel.createMyGroupChannelListQuery();
listQuery.includeEmpty = true;
listQuery.memberStateFilter = 'joined_only';    // 'all', 'joined_only', 'invited_only', 'invited_by_friend', and 'invited_by_non_friend'
listQuery.order = 'latest_last_message';    // 'chronological', 'latest_last_message', 'channel_name_alphabetical', and 'metadata_value_alphabetical'
listQuery.limit = 15;   // The value of pagination limit could be set up to 100.

if (listQuery.hasNext) {
    listQuery.next(function(groupChannels, error) {
        if (error) {
            // Handle error.
        }

        // A list of group channels is successfully retrieved.
        // Through the "groupChannels" parameter of the callback function,
        // you can access the data of each group channel from the result list that Sendbird server has passed to the callback function.
        groupChannels.forEach(channel => {
            ...
        });

        ...
    });
}

You can also get a list of the current user's public group channels after creating a PublicGroupChannelListQuery instance from the createPublicGroupChannelListQuery() and using the next() method, which returns a list of group channel objects.

Note: Using the includeEmpty option of the PublicGroupChannelListQuery 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 the Chat history option in your dashboard, you may retrieve empty channels in the result.

Light Color Skin
Copy
var listQuery = sb.GroupChannel.createPublicGroupChannelListQuery();
listQuery.includeEmpty = true;
listQuery.membershipFilter = 'joined';      // 'all' and 'joined'
listQuery.order = 'channel_name_alphabetical';  // 'chronological', 'channel_name_alphabetical', and 'metadata_value_alphabetical'
listQuery.limit = 15;   // The value of pagination limit could be set up to 100.

if (listQuery.hasNext) {
    listQuery.next(function(groupChannels, error) {
        if (error) {
            // Handle error.
        }

        // A list of public group channels matching search criteria is successfully retrieved.
        // Through the "groupChannels" parameter of the callback function,
        // you can access the data of each group channel from the result list that Sendbird server has passed to the callback function.
        groupChannels.forEach(channel => {
            ...
        });

        ...
    });
}

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.

Light Color Skin
Copy
sb.GroupChannel.getChannel(CHANNEL_URL, function(groupChannel, error) {
    if (error) {
        // Handle error.
    }

    // Through the "groupChannel" parameter of the callback function,
    // the group channel object identified with the CHANNEL_URL is returned by Sendbird server,
    // and you can get the group channel's data from the result object.
    const channelName = groupChannel.name;
    ...
});

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.

Light Color Skin
Copy
// Hiding (archiving) a group channel.
groupChannel.hide(IS_HIDE_PREVIOUS_MESSAGES, IS_ALLOW_AUTO_UNHIDE, function(response, error) {
    if (error) {
        // Handle error.
    }

    // The channel successfully gets hidden from the list.
    // The current user's channel view should be refreshed to reflect the change.
    ...
});

// Unhiding a group channel.
groupChannel.unhide(function(response, error) {
    if (error) {
        // Handle error.
    }

    // The channel successfully gets unhidden from the list.
    // The current user's channel view should be refreshed to reflect the change.
    ...
});
ArgumentTypeDescription

IS_HIDE_PREVIOUS_MESSAGES

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)

IS_ALLOW_AUTO_UNHIDE

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 unhide() is called for unarchiving.

Using the channel.hiddenState, you can check the channel state with regard to the list.

Light Color Skin
Copy
if (groupChannel.hiddenState === sb.GroupChannel.HiddenState.UNHIDDEN) {
    // Display the channel in the list.
} else if (groupChannel.hiddenState === sb.GroupChannel.HiddenState.HIDDEN_ALLOW_AUTO_UNHIDE) {
    // Hide the channel from the list, and get it appeared back on condition.
} else if (groupChannel.hiddenState === sb.GroupChannel.HiddenState.HIDDEN_PREVENT_AUTO_UNHIDE) {
    // Archive the channel, and get it appeared back in the list only when the unhide() is called.
}

You can also filter channels by their state like the following:

Light Color Skin
Copy
var listQuery = sb.GroupChannel.createMyGroupChannelListQuery();
listQuery.includeEmpty = true;
// The filter options are limited to 'UNHIDDEN', 'HIDDEN', 'HIDDEN_ALLOW_AUTO_UNHIDE', or 'HIDDEN_PREVENT_AUTO_UNHIDE'.
// If set to 'HIDDEN', hidden and archived channels are returned.
listQuery.hiddenChannelFilter = sb.GroupChannel.HiddenChannelFilter.HIDDEN_PREVENT_AUTO_UNHIDE;

listQuery.next(function(grouChannels, error) {
    if (error) {
        // Handle error.
    }

    // Only archived channels are returned in a result list through the "groupChannels" parameter of the callback function.
    ...
});

Filter channels by user IDs

To filter group 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-on-1 group channels with the specified user.

Light Color Skin
Copy
var listQuery = sb.GroupChannel.createMyGroupChannelListQuery();
listQuery.userIdsExactFilter = ['John', 'Jay'];

listQuery.next(function(groupChannels, error) {
    if (error) {
        // Handle error.
    }

    // Only channelA is returned in a result list through the "groupChannels" parameter of the callback function.
    ...
});

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.

Light Color Skin
Copy
var listQuery = sb.GroupChannel.createMyGroupChannelListQuery();
listQuery.userIdsIncludeFilter = ['John', 'Jay', 'Jin'];

listQuery.next(function(groupChannels, error) {
    if (error) {
        // Handle error.
    }

    // Only channelB including {'John', 'Jay', 'Jin'} as a subset is returned in a result list.
    ...
});

...

listQuery.queryType = sb.GroupChannelListQuery.QueryType.OR;

listQuery.next(function(groupChannels, error) {
    if (error) {
        // Handle error.
    }

    // channelA and channelB including {'John'}, channelA and channelB including {'Jay'}, channelB that including {'Jin'}.
    // Actually, channelA and channelB are returned in a result list.
    ...
});

Send a message

In a group channel, users can send messages of the following types:

Message typeDescription

UserMessage

A text message sent by a user

FileMessage

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 callback function of the sendUserMessage() method, Sendbird server always notifies whether your text 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 function.

Light Color Skin
Copy
const params = new sb.UserMessageParams();

params.message = TEXT_MESSAGE;
params.customType = CUSTOM_TYPE;
params.data = DATA;
params.mentionType = 'users';                       // Either 'users' or 'channel'
params.mentionedUserIds = ['Jeff', 'Julia'];        // Or mentionedUsers = Array<User>;
params.metaArrays = [   // A pair of key-value
    new sendBirds.me.MessageMetaArray('itemType', ['tablet']),
    new sendBirds.me.MessageMetaArray('quality', ['best', 'good'])
];
params.translationTargetLanguages = ['fe', 'de'];   // French and German
params.pushNotificationDeliveryOption = 'default';  // Either 'default' or 'suppress'

groupChannel.sendUserMessage(params, function(userMessage, error) {
    if (error) {
        // Handle error.
    }

    // A text message with detailed configuration is successfully sent to the channel.
    // By using userMesage.messageId, userMessage.message, userMessage.customType, and so on,
    // you can access the result object from Sendbird server to check your UserMessageParams configuration.
    // The current user can receive messages from other users through the onMessageReceived() method of an event handler.
    const messageId = userMessage.messageId;
    ...
});

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 callback function of the sendFileMessage() method, Sendbird server always notifies whether your file 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 function.

Light Color Skin
Copy
// Sending a file message with a raw file
const params = new sb.FileMessageParams();

params.file = FILE;             // Or .fileUrl  = FILE_URL (You can also send a file message with a file URL.)
params.fileName = FILE_NAME;
params.fileSize = FILE_SIZE;
params.thumbnailSizes = [{maxWidth: 100, maxHeight: 100}, {maxWidth: 200, maxHeight: 200}]; // Add the maximum sizes of thumbnail images (allowed number of thumbnail images: 3).
params.mimeType = MIME_TYPE;
params.customType = CUSTOM_TYPE;
params.mentionType = 'users';                       // Either 'users' or 'channel'
params.mentionedUserIds = ['Jeff', 'Julia'];        // Or mentionedUsers = Array<User>;
params.pushNotificationDeliveryOption = 'default';  // Either 'default' or 'suppress'

groupChannel.sendFileMessage(params, function(fileMessage, error) {
    if (error) {
        // Handle error.
    }

    // A file message with detailed configuration is successfully sent to the channel.
    // By using fileMesage.messageId, fileMessage.fileName, fileMessage.customType, and so on,
    // you can access the result object from Sendbird server to check your FileMessageParams configuration.
    // The current user can receive messages from other users through the onMessageReceived() method of an event handler.
    const messageId = fileMessage.messageId;
    ...
});

Receive messages through a channel event handler

Messages sent from other members can be received through the onMessageReceived() method in the channel event handler. A BaseMessage object for each received message is one of the following three message types.

Message typeDescription

UserMessage

A text message sent by a user

FileMessage

A binary file message sent by a user

AdminMessage

A text message sent by an admin through the Chat API

UNIQUE_HANDLER_ID is a unique identifier to register multiple concurrent handlers.

Light Color Skin
Copy
var channelHandler = new sb.ChannelHandler();

channelHandler.onMessageReceived = function(channel, message) {
    console.log(channel, message);
};

sb.addChannelHandler(UNIQUE_HANDLER_ID, channelHandler);

When the UI isn't valid anymore, remove the channel event handler.

Light Color Skin
Copy
sb.removeChannelHandler(UNIQUE_HANDLER_ID);

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.

Light Color Skin
Copy
// Create a `UserMessageParams` object.
const params = new sb.UserMessageParams();
params.parentMessageId = PARENT_MESSAGE_ID; // This specifies the unique ID of a parent message which has a thread of replies. If the message sent through the `sendUserMessage()` method is a parent message, the value of this property is 0.
...

// Pass the params to the parameter of the `sendUserMessage()` method.
groupChannel.sendUserMessage(params, (message, error) => {
    if (error) {
        // Handle error.
    }

    // A reply to a specific message in the form of a text message is successfully sent.
    ...
});
ArgumentTypeDescription

PARENT_MESSAGE_ID

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 sendUserMessage() method is a parent message, the value of this property is 0. If the message is a reply to a parent message, the value is the message ID of the parent message.

Reply with a file message

When replying with a file message through the sendFileMessage() method, specify and pass a FileMessageParams object as an argument to a parameter in the method.

Light Color Skin
Copy
// Create a `FileMessageParams` object.
const params = new sb.FileMessageParams();
params.file = FILE;
params.parentMessageId = PARENT_MESSAGE_ID; // This specifies the unique ID of a parent message which has a thread of replies. If the message sent through the `sendUserMessage()` method is a parent message, the value of this property is 0.
...

// Pass the params to the parameter in the `sendFileMessage()` method.
groupChannel.sendFileMessage(params, (message, error) => {
    if (error) {
        // Handle error.
    }

    // A reply to a specific message in the form of a file message is successfully sent.
    ...
});
ArgumentTypeDescription

FILE

string

Specifies the URL of the file to be attached to the message.

PARENT_MESSAGE_ID

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 sendUserMessage() method is a parent message, the value of this property is 0. If the message is a reply to a parent message, the value is the message ID of the parent message.


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:

  1. Specify a list of the user IDs to mention.
  2. Add the list to either UserMessageParams or FileMessageParams which may contain options for further action.
  3. Pass the params to either sendUserMessage() or sendFileMessage().
  4. Then only up to 10 members mentioned in the message will be notified.
Light Color Skin
Copy
var params = new sb.UserMessageParams();
params.message = MESSAGE;
params.mentionedUserIds = ['Harry', 'Jay', 'Jin'];

groupChannel.sendUserMessage(params, function(message, error) {
    if (error) {
        // Handle error.
    }

    ...
});

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.

Light Color Skin
Copy
const emojiKey = "smile";
groupChannel.addReaction(message, emojiKey, function(reactionEvent, error) {
    if (error) {
        // Handle error.
    }

    message.applyReactionEvent(reactionEvent);
    ...

});

groupChannel.deleteReaction(message, emojiKey, function(reactionEvent, error) {
    if (error) {
        // Handle error.
    }

    message.applyReactionEvent(reactionEvent);
    ...

});

// Note: To add or remove the emoji of which key matches 'smile' below the message on the current user's chat view,
// the applyReactionEvent() method should be called in the channel event handler's onReactionUpdated() method.

You can decide how to display reactions that were added to messages in the current user’s chat view.

Light Color Skin
Copy
groupChannel.getPreviousMessagesByTimestamp(TIMESTAMP, ... , INCLUDE_REACTION, function(messages, error) {
    if (error) {
        // Handle error.
    }

    for (let i in messages) {
        const message = messages[i];
        ...
        for (let j in message.reactions) {
            const reaction = message.reactions[j];
            const userIds = reaction.userIds;

            // Check if this emoji has been used when the current user reacted to the message.
            if (userIds.include(sb.getCurrentUser())) {
                const key = reaction.key;
                const updatedAt = reactino.updatedAt;

                // Show the emoji however you want on the current user's chat view.
            }
        }
    }

    ...
});

Note: Messages along with their reactions can also be retrieved by using the PreviousMessageListQuery's load() 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.

Light Color Skin
Copy
const channelHandler = new sb.ChannelHandler();

channelHandler.onReactionUpdated = function(channel, reactionEvent) {
    ...

    // If there is a message with the reactionEvent.messageId,
    // you can apply the reaction change to the message by calling the applyReactionEvent() method.
    message.applyReactionEvent(reactionEvent);

    // Add or remove an emoji below the message on the current user's chat view.
};

sb.addChannelHandler(UNIQUE_HANDLER_ID, channelHandler);

Load previous messages

After creating a query instance from the createPreviousMessageListQuery() method and using the instance's load() method which returns a list of message 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.

Light Color Skin
Copy
// There should only be one single instance per channel view.
var listQuery = groupChannel.createPreviousMessageListQuery();
listQuery.limit = LIMIT;
listQuery.reverse = REVERSE;
listQuery.includeMetaArray = true;  // Retrieve a list of messages along with their metaarrays.
listQuery.includeReaction = true;   // Retrieve a list of messages along with their reactions.
...

// Retrieving previous messages.
listQuery.load(function(messages, error) {
    if (error) {
        // Handle error.
    }

    ...
});
ArgumentTypeDescription

LIMIT

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.

REVERSE

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.

The LIMIT parameter indicates how many messages should be included in a returned list. A query 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 query instance and call the load() method, a set number of the most recently sent 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 its 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.

NameFilters...

MessageTypeFilter

Messages with the specified message type. Specifying the messageTypeFilter option with a message type enables this filter.

CustomTypeFilter

Messages with the specified custom message type. Specifying the customTypeFilter option with a custom message type enables this filter.

SenderUserIdsFilter

Messages that are sent by the specified users. Specifying the senderUserIdsFilter option with an array of user IDs enables this filter.


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.

Light Color Skin
Copy
const params = new sb.MessageListParams();
params.isInclusive = IS_INCLUSIVE;
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.shouldReverse = REVERSE;
params.messageType = MESSAGE_TYPE;
params.customType = CUSTOM_TYPE;
...

groupChannel.getMessagesByTimestamp(TIMESTAMP, params, function(messages, error) {
    if (error) {
        // Handle error.
    }

    // A list of previous and next messages on both sides of a specified timestamp is successfully retrieved.
    // Through the "messages" parameter of the callback function,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback function.
    messages.forEach(message => {
        ...
    });

    ...
});
ArgumentTypeDescription

TIMESTAMP

number

Specifies the timestamp to be the reference point of a retrieval, in Unix milliseconds.

IS_INCLUSIVE

boolean

Determines whether to include the messages sent exactly on the TIMESTAMP.

PREV_RESULT_SIZE

number

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.

NEXT_RESULT_SIZE

number

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.

REVERSE

boolean

Determines whether to sort the retrieved messages in reverse order.

MESSAGE_TYPE

string

Specifies the message type to filter the messages with the corresponding type. Acceptable values are MESG, FILE, ADMM, or leaving it empty. If left empty, all types of messages are returned.

CUSTOM_TYPE

string

Specifies the custom message type to filter the messages with the corresponding custom type.

function()

callback

Specifies the callback function which receives the response from Sendbird server for a message retrieval request.

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.

Light Color Skin
Copy
const params = new sb.MessageListParams();
params.isInclusive = IS_INCLUSIVE;
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.shouldReverse = REVERSE;
params.messageType = MESSAGE_TYPE;
params.customType = CUSTOM_TYPE;
...

groupChannel.getMessagesByMessageId(MESSAGE_ID, params, function(messages, error) {
    if (error) {
        // Handle error.
    }

    // A list of previous and next messages on both sides of a specified message ID is successfully retrieved.
    // Through the "messages" parameter of the callback function,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback function.
    messages.forEach(message => {
        ...
    });

    ...
});
ArgumentTypeDescription

MESSAGE_ID

long

Specifies the unique ID of the message to be the reference point of a retrieval.

IS_INCLUSIVE

boolean

Determines whether to include the message identified with a specified message ID.

PREV_RESULT_SIZE

number

Specifies the number of messages to retrieve, which are sent previously before a specified message ID.

NEXT_RESULT_SIZE

number

Specifies the number of messages to retrieve, which are sent later after a specified timestamp.

REVERSE

boolean

Determines whether to sort the retrieved messages in reverse order.

MESSAGE_TYPE

string

Specifies the message type to filter the messages with the corresponding type. Acceptable values are MESG, FILE, ADMM, or leaving it empty. If left empty, all types of messages are returned.

CUSTOM_TYPE

string

Specifies the custom message type to filter the messages with the corresponding custom type.

function()

callback

Specifies the callback function which receives the response from Sendbird server for a message retrieval request.


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. Using this method, you can retrieve previous messages in a specific channel.

To include the replies of the target messages in the results, change the value of the includeReplies property set to true.

Light Color Skin
Copy
const listQuery = channel.createPreviousMessageListQuery();
listQuery.includeReplies = INCLUDE_REPLIES;
listQuery.includeThreadInfo = INCLUDE_THREAD_INFO;
listQuery.includeParentMessageText = INCLUDE_PARENT_MESSAGE_TEXT;

// This retrieves previous messages in a channel.
listQuery.load(LIMIT, REVERSE, MESSAGE_TYPE_FILTER, (messages, error) => {
    if (error) {
        // Handle error.
    }

    ...
});
ArgumentTypeDescription

LIMIT

number

Specifies the number of results to return per call. Acceptable values are 1 to 100, inclusive. The recommended value for this parameter is 30.

REVERSE

boolean

Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.

MESSAGE_TYPE_FILTER

string

Restricts the search scope only to retrieve messages with the specified message type.

INCLUDE_REPLIES

boolean

Determines whether to include replies in the results.

INCLUDE_THREAD_INFO

boolean

Determines whether to include the thread information of the messages in the results when the results contain parent messages.

INCLUDE_PARENT_MESSAGE_TEXT

boolean

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 UserMessage, the value is a message property. If it is FileMessage, the value is the name of the uploaded file.

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.

- By timestamp

The getMessagesByTimestamp() method retrieves a set number of previous and next messages on both sides of a specific timestamp in a channel.

Light Color Skin
Copy
// Create a `MessageListParams` object.
const params = new sb.MessageListParams();
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.isInclusive = INCLUSIVE;
params.reverse = REVERSE;
params.includeReplies = INCLUDE_REPLIES;
params.includeThreadInfo = INCLUDE_THREAD_INFO;
params.includeParentMessageText = INCLUDE_PARENT_MESSAGE_TEXT;
...

// Pass the params as an argument to the `getMessagesByTimestamp()` method.
groupChannel.getMessagesByTimestamp(TIMESTAMP, params, (messages, error) => {
    if (error) {
        // Handle error.
    }

    // A list of previous and next messages on both sides of a specified timestamp is successfully retrieved.
    // Through the "messages" parameter of the callback function,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback function.
    messages.forEach(message => {
        ...
    });

    ...
});
ArgumentTypeDescription

TIMESTAMP

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.

PREV_RESULT_SIZE

int

Specifies the number of messages to retrieve that were sent before the specified timestamp or message ID.

NEXT_RESULT_SIZE

int

Specifies the number of messages to retrieve that were sent after the specified timestamp or message ID.

INCLUSIVE

boolean

Determines whether to include the messages with the matching timestamp or message ID in the results.

REVERSE

boolean

Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.

INCLUDE_REPLIES

boolean

Determines whether to include replies in the results.

INCLUDE_THREAD_INFO

boolean

Determines whether to include the thread information of the messages in the results when the results contain parent messages.

INCLUDE_PARENT_MESSAGE_TEXT

boolean

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 UserMessage, the value is a message property. If it is FileMessage, the value is the name of the uploaded file.

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

Light Color Skin
Copy
// Create a `MessageListParams` object.
const params = new sb.MessageListParams();
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.isInclusive = INCLUSIVE;
params.reverse = REVERSE;
params.includeReplies = INCLUDE_REPLIES;
params.includeThreadInfo = INCLUDE_THREAD_INFO;
params.includeParentMessageText = INCLUDE_PARENT_MESSAGE_TEXT;
...

// Pass the params as an argument to the `getMessagesByMessageId()` method.
groupChannel.getMessagesByMessageId(MESSAGE_ID, params, (messages, error) => {
    if (error) {
        // Handle error.
    }

    // A list of previous and next messages on both sides of a specified message ID is successfully retrieved.
    // Through the "messages" parameter of the callback function,
    // you can access and display the data of each message from the result list that Sendbird server has passed to the callback function.
    messages.forEach(message => {
        ...
    });

    ...
});
ArgumentTypeDescription

MESSAGE_ID

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.

PREV_RESULT_SIZE

int

Specifies the number of messages to retrieve that were sent before the specified timestamp or message ID.

NEXT_RESULT_SIZE

int

Specifies the number of messages to retrieve that were sent after the specified timestamp or message ID.

INCLUSIVE

boolean

Determines whether to include the messages with the matching timestamp or message ID in the results.

REVERSE

boolean

Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.

INCLUDE_REPLIES

boolean

Determines whether to include replies in the results.

INCLUDE_THREAD_INFO

boolean

Determines whether to include the thread information of the messages in the results when the results contain parent messages.

INCLUDE_PARENT_MESSAGE_TEXT

boolean

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 UserMessage, the value is a message property. If it is FileMessage, the value is the name of the uploaded file.


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 as an argument.

Light Color Skin
Copy
// Create a `ThreadMessageListParams` object.
const params = new sb.ThreadedMessageListParams();
params.prevResultSize = PREV_RESULT_SIZE;
params.nextResultSize = NEXT_RESULT_SIZE;
params.isInclusive = INCLUSIVE;
params.reverse = REVERSE;
params.includeParentMessageText = INCLUDE_PARENT_MESSAGE_TEXT;

// Pass the params as an argument to the parameter in the `getThreadedMessagesByTimestamp()` method.
parentMessage.getThreadedMessagesByTimestamp(TIMESTAMP, params, ({ parentMessage, threadedReplies }, error) => {
    if (error) {
        // Handle error.
    }

    // A list of replies of the specified parent message timestamp is successfully retrieved.
    ...
});
ArgumentTypeDescription

TIMESTAMP

long

Specifies the timestamp to be the reference point of the retrieval, in Unix milliseconds format.

PREV_RESULT_SIZE

int

Specifies the number of messages to retrieve that were sent before the specified timestamp or message ID.

NEXT_RESULT_SIZE

int

Specifies the number of messages to retrieve that were sent after the specified timestamp or message ID.

INCLUSIVE

boolean

Determines whether to include the messages with the matching timestamp or message ID in the results.

REVERSE

boolean

Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.

INCLUDE_PARENT_MESSAGE_TEXT

boolean

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 UserMessage, the value is a message property. If it is FileMessage, the value is the name of the uploaded file.


Retrieve a message

You can retrieve a specific message by creating and passing the MessageRetrievalParams object to the getMessage() method as an argument.

Light Color Skin
Copy
// Create a `MessageRetrievalParams` object.
const params = new sb.MessageRetrievalParams();
params.messageId = MESSAGE_ID;
params.channelType = CHANNEL_TYPE;
params.channelUrl = CHANNEL_URL;
...

// Pass the params as an argument to the parameter in the `getMessage()` method.
sb.BaseMessage.getMessage(params, (message, error) => {
    if (error) {
        // Handle error.
    }

    // The specified message is successfully retrieved.
    ...
});
ArgumentTypeDescription

MESSAGE_ID

long

Specifies the unique ID of the message to retrieve.

CHANNEL_TYPE

String

Specifies the type of the channel.

CHANNEL_URL

String

Specifies the URL of the channel to retrieve the message.


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.

User message
File message
Light Color Skin
Copy
const params = new sb.UserMessageParams();

params.message = NEW_TEXT_MESSAGE;
params.customType = NEW_CUSTOM_TYPE;
params.data = NEW_DATA;

// The MESSAGE_ID below indicates the unique message ID of a UserMessage object to update.
groupChannel.updateUserMessage(MESSAGE_ID, params, function(message, error) {
    if (error) {
        // Handle error.
    }

    // The message is successfully updated.
    // Through the "userMessage" parameter of the callback function,
    // you could check if the update operation has been performed correctly.
    const text = userMessage.message;
    ...
});
Light Color Skin
Copy
const params = new sb.FileMessageParams();

params.fileUrl = NEW_FILE_URL;      // The file in a message can't be updated.
params.fileName = NEW_FILE_NAME;
params.fileSize = NEW_FILE_SIZE;
params.customType = NEW_CUSTOM_TYPE;

// The MESSAGE_ID below indicates the unique message ID of a FileMessage object to update.
groupChannel.updateFileMessage(MESSAGE_ID, params, function(message, error) {
    if (error) {
        // Handle error.
    }

    // The message is successfully updated.
    // Through the "fileMessage" parameter of the callback function,
    // you could check if the update operation has been performed correctly.
    const customType = fileMessage.customType;
    ...
});

If a message is updated, the onMessageUpdated() method in the channel event handler will be invoked on all channel participants' devices except the one that updated the message.

Light Color Skin
Copy
var channelHandler = new sb.ChannelHandler();

channelHandler.onMessageUpdated = function(channel, message) {
    ...
};

sb.addChannelHandler(UNIQUE_HANDLER_ID, channelHandler);

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.

Light Color Skin
Copy
// The MESSAGE below indicates a UserMessage or FileMessage object to delete.
groupChannel.deleteMessage(MESSAGE, function(response, error) {
    if (error) {
        // Handle error.
    }

    // The message is successfully deleted from the channel.
    ...
});

If a message is deleted, the onMessageDeleted() method in the channel event handler will be invoked on all channel participants' devices including the one that deleted the message.

Light Color Skin
Copy
var channelHandler = new sb.ChannelHandler();

channelHandler.onMessageDeleted = function(channel, messageId) {
    ...
};

sb.addChannelHandler(UNIQUE_HANDLER_ID, channelHandler);

Copy a message

A user can copy and send their own message in the same channel or to another channel.

User message
File message
Light Color Skin
Copy
groupChannel.copyUserMessage(TARGET_CHANNEL, MESSAGE_TO_COPY, function(message, error) {
    if (error) {
        // Handle error.
    }

    // The message is successfully copied to the target channel.
    ...
});
Light Color Skin
Copy
groupChannel.copyFileMessage(TARGET_CHANNEL, MESSAGE_TO_COPY, function(message, error) {
    if (error) {
        // Handle error.
    }

    // The message is successfully copied to the target channel.
    ...
});
ArgumentTypeDescription

TARGET_CHANNEL

object

Specifies a target channel to send a copied message to.

MESSAGE_TO_COPY

object

Specifies a message to copy.

function()

callback

Specifies the callback function to receive the response from Sendbird server for a message copy request.


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.

Light Color Skin
Copy
groupChannel.resetMyHistory(function(response, error) {
    if (error) {
        // Handle error.
    }

    ...
});

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.

Light Color Skin
Copy
groupChannel.refresh(function(response, error) {
    if (error) {
        // Handle error.
    }

    ...
});

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 the onReconnectSucceeded() method which receives a callback from Sendbird server when successfully reconnected.


Retrieve a list of all members

You can retrieve a list of members in a group channel using members.

Light Color Skin
Copy
groupChannel.members;

Members of a 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 members to retrieve the members of the channel.

By calling user.connectionStatus at each User object in a list which the members returns, you can check user's current connection status. The connectionStatus has one of the following two values:

ValueDescription

offline

The user is not connected to Sendbird server.

online

The user is connected to Sendbird server.


Retrieve a list of members and operators in a specific order

The members and operators of a group channel can be retrieved by calling the createMemberListQuery() method of a memberListQuery instance. For a specific order, set one of the options in the following table to the order property of memberListQuery.

- MemberListQuery.Order

ValueDescription

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.

Light Color Skin
Copy
const memberListQuery = groupChannel.createMemberListQuery();
memberListQuery.limit = 10;
memberListQuery.order = sb.MemberListQuery.Order.OPERATOR_THEN_MEMBER_ALPHABETICAL;

memberListQuery.next((users, error) => {
    // A list of matching members and operators is successfully retrieved.
    // Through the "users" parameter of the callback function,
    // you can access the data of each item from the result list that Sendbird server has passed to the callback function.
    users.forEach(user => {
        ...
    });
});

- operatorFilter

For filtering, input one of the options in the table below to the operatorFilter property of memberListQuery.

ValueDescription

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.

Light Color Skin
Copy
const memberListQuery = groupChannel.createMemberListQuery();
memberListQuery.limit = 10;
memberListQuery.operatorFilter =OPERATOR;  // ALL, OPERATOR, and NONOPERATOR

memberListQuery.next((users, error) => {
    // A list of matching members and operators is successfully retrieved.
    // Through the "users" parameter of the callback function,
    // you can access the data of each item from the result list that Sendbird server has passed to the callback function.
    users.forEach(user => {
        ...
    });
});

Retrieve a list of operators

You can follow the simple implementation below to retrieve a list of operators who monitor and control the activities in a group channel.

Light Color Skin
Copy
var listQuery = groupChannel.createOperatorListQuery();
listQuery.next(function(operators, error) {
    if (error) {
        // Handle error.
    }

    // A list of the operators of the channel is successfully retrieved.
    // Through the "operator" parameter of the callback function,
    // you can access and display the data of each operator from the result list that Sendbird server has passed to the callback function.
    operators.forEach(operator => {
        ...
    });

    ...
});

Register operators

You can register members as operators of a group channel.

Light Color Skin
Copy
groupChannel.addOperators(OPERATOR_USER_IDS, function(response, error) {
    if (error) {
        // Handle error.
    }

    // The participants are successfully registered as operators of the channel.
    ...
});

Cancel the registration of operators

You can cancel the registration of operators from a group channel but leave them as members.

Light Color Skin
Copy
groupChannel.removeOperators(OPERATOR_USER_IDS, function(response, error) {
    if (error) {
        // Handle error.
    }

    // The cancel operation is succeeded,
    // and you could display some message to those who are not operators anymore.
    ...
});

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.

Light Color Skin
Copy
// Retrieving banned users
var listQuery = groupChannel.createBannedUserListQuery();
listQuery.next(function(users, error) {
    if (error) {
        // Handle error.
    }

    ...
});

// Retrieving muted users
var listQuery = groupChannel.createMemberListQuery();
listQuery.mutedMemberFilter = 'muted';
listQuery.next(function(users, error) {
    if (error) {
        // Handle error.
    }

    ...
});

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 in group channels using the following code.

Light Color Skin
Copy
sb.GroupChannel.getChannel(channelUrl, function(groupChannel, error) {
    if (error) {
        // Handle error.
    }

    // Banning and unbanning a user
    if (groupChannel.myRole === sb.Member.Role.OPERATOR) {
        groupChannel.banUser(USER, SECONDS, DESCRIPTION, function(response, error) {
            if (error) {
                // Handle error.
            }

            // The user is successfully banned from the channel.
            // You could notify the user of being banned by displaying a prompt.
            ...
        });

        groupChannel.unbanUser(USER, function(response, error) {
            if (error) {
                // Handle error.
            }

            // The user is successfully unbanned for the channel.
            // You could notify the user of being unbanned by displaying a prompt.
            ...
        });
    }
});

Note: You can also use the banUserWithUserId() and unbanUserWithUserId() methods, instead of the banUser() and unbanUser(), as they have the same functionalities. You can find more information on the banUserWithUserId() and unbanUserWithUserID() in our API reference.


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:

Light Color Skin
Copy
sb.GroupChannel.getChannel(channelUrl, function(groupChannel, error) {
    if (error) {
        // Handle error.
    }

    // Muting and unmuting a user
    if (groupChannel.myRole === sb.Member.Role.OPERATOR) {
        groupChannel.muteUser(USER, function(response, error) {
            if (error) {
                // Handle error.
            }

            // The user is successfully muted in the channel.
            // You could notify the user of being muted by displaying a prompt.
            ...
        });

        groupChannel.unmuteUser(USER, function(response, error) {
            if (error) {
                // Handle error.
            }

            // The user is successfully unmuted in the channel.
            // You could notify the user of being unmuted by displaying a prompt.
            ...
        });
    }
});

Note: You can also use the muteUserWithUserId() and unmuteUserWithUserId(), instead of the muteUser() and unmuteUser(), as they have the same functionalities. You can find more information on the muteUserWithUserId() and unmuteUserWithUserID() in our API reference.


Report a message, a user, or a channel

In a group channel, a user can report suspicious or harrassing 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.

Light Color Skin
Copy
// Reporting a message.
groupChannel.reportMessage(MESSAGE_TO_REPORT, REPORT_CATEGORY, DESCRIPTION, function(error) {
    if (error) {
        // Handle error.
    }

    ...
});

// Reporting a user.
groupChannel.reportUser(OFFENDING_USER, REPORT_CATEGORY, DESCRIPTION, function(error) {
    if (error) {
        // Handle error.
    }

    ...
});

// Reporting a channel.
groupChannel.report(REPORT_CATEGORY, DESCRIPTION, function(erorr) {
    if (error) {
        // Handle error.
    }

    ...
});
ArgumentTypeDescription

MESSAGE_TO_REPORT

object

Specifies the message to report for its suspicious, harassing, or inappropriate content.

OFFENDING_USER

object

Specifies the user who uses offensive or abusive language such as sending explicit messages or inappropriate comments.

REPORT_CATEGORY

enum

Specifies a report category which indicates the reason for reporting. Acceptable values are limited to suspicious, harassing, inappropriate, and spam.

DESCRIPTION

string

Specifies additional information to include in the report.