Open Channel: Advanced

This section explains the premium features of Open Channel. Some are available only to a paying user.


Send admin messages to an open channel

You can send an admin message to users in a channel using the SendBird Dashboard or the Platform API. To send the admin message via the Dashboard, in the Open Channels panel, select an open channel, find a message box below, click the Admin Message tab, and write a message in the box. The admin message is limited to 1000 characters.

Note: If you are currently developing under the Free Plan and therefore cannot use the Moderation Tools from the Dashboard, you must send the admin messages through the Platform API.


Categorize open channels by custom types

When creating a channel, you can additionally specify a custom type to further subclassify your channels. This custom type takes on the form of a String, and can be handy in searching or filtering channels.

Note: DATA and CUSTOM_TYPE are both String fields that allow you to append information to your channels. The intended use case is for CUSTOM_TYPE to contain information that can subclassify the channel (for example, distinguishing School and Work channels). However, both these fields can be flexibly utilized.

sb.OpenChannel.createChannel(NAME, COVER_URL, DATA, CUSTOM_TYPE, function(channel, error){
    if (error) {
        return;
    }

    // onCreated
});

To get a channel's custom type, call channel.customType


Categorize messages in an open channels by custom types

Likewise, you can specify a custom type for messages to categorize them into more specific groups. This custom type takes on the form of a String, and can be useful in searching or filtering messages.

Note: DATA and CUSTOM_TYPE are both String fields that allow you to append information to your messages. The intended use case is for CUSTOM_TYPE to contain information that can subclassify the message (for example, distinguishing FILE_IMAGE and FILE_AUDIO type messages). However, both these fields can be flexibly utilized.

To embed a custom type into a message, pass a String parameter to sendUserMessage() or sendFileMessage().

channel.sendUserMessage(MESSAGE, DATA, CUSTOM_TYPE, function(message, error){
    if (error) {
        return;
    }

    // onSent
});

To get a message's custom type, call message.customType.


Search for open channels by name and URL

You can search for specific channels by adding a keyword to OpenChannelListQuery instance. There are two types of keywords: a Name and a URL. A query returns a list of open channels that partially match the specified Name keyword in the names of the channels.

var openChannelListQuery = sb.OpenChannel.createOpenChannelListQuery();
openChannelListQuery.nameKeyword = "SendBird";

openChannelListQuery.next(function (channels, error) {
    if (error) {
        return;
    }

    // Returns a list of channels that have "SendBird" in their names.
    console.log(channels);
});

A query returns a list of open channels that partially match the specified URL keyword in the urls of the channels.

var openChannelListQuery = sb.OpenChannel.createOpenChannelListQuery();
openChannelListQuery.urlKeyword = "seminar";

openChannelListQuery.next(function (channels, error) {
    if (error) {
        return;
    }

    // Returns a list of open channels that have "seminar" in their urls.
    console.log(channels);
});

Generate thumbnails of a file message

When sending an image file, you can choose to create thumbnails of the image, which you can fetch and render into your UI. You can specify up to 3 different dimensions to generate thumbnail images in, which can be convenient for supporting various display densities.

Note: Supported file types are files whose media type is image/* or video/*. The SDK does not support creating thumbnails when sending a file message via a file URL.

Create a list of FileMessage.ThumbnailSize objects to pass to channel.sendFileMessage(). A ThumbnailSize can be created with the constructor ThumbnailSize(int maxWidth, int maxHeight), where the values specify pixels. The callback function subsequently returns a list of Thumbnail objects that each contain the URL of the generated thumbnail image file.

var thumbnailSizes = [];
// Create and add ThumbnailSizes (Max: 3 ThumbnailSizes).
thumbnailSizes.push({'maxWidth': 100,'maxHeight': 100});
thumbnailSizes.push({'maxWidth': 200,'maxHeight': 200});

channel.sendFileMessage(FILE, DATA, CUSTOM_TYPE, thumbnailSizes, function(fileMessage, error){
    if (error) {
        return;
    }

    var thumbnailFirst = fileMessage.thumbnails[0];
    var thumbnailSecond = fileMessage.thumbnails[1];

    var maxHeightFirst = thumbnailFirst.maxHeight; // 100
    var maxHeightSecond = thumbnailSecond.maxHeight; // 200

    var urlFirst = thumbnailFirst.url; // URL of first thumbnail file.
    var urlSecond = thumbnailSecond.url; // URL of second thumbnail file.
});

maxWidth and maxHeight specify the maximum dimensions of the thumbnail. Your image is resized evenly to fit within the bounds of (maxWidth, maxHeight). Note that if the original image is smaller than the specified dimensions, the thumbnail isn't resized. url returns the location of the generated thumbnail file within the SendBird servers.

As this is one of SendBird's Premium Features, please contact our sales team for further assistance.


Track file upload progress using a handler

You can track the file upload progress by passing progressHandler as a parameter when calling sendFileMessage().

var sentFileMessage = channel.sendFileMessage(FILE, '', '', 
    function(event) { // check progress of upload request
        // do something...
        console.log(parseInt(Math.floor(e.loaded/e.total * 100)) + '%');
    },
    function(fileMessage, error) { // callback
        // do something...
        console.log(fileMessage, error);
    }
);

Cancel an in-progress file upload

You can cancel an in-progress file upload while it is not yet completed. If this function runs successfully, it returns true.

Note: If you attempt to cancel the uploading after it is already completed, or cancelled, or returned an error, the function returns false.

var sentFileMessage = channel.sendFileMessage(FILE, '', '', function(fileMessage, error) {
    // do something...
    console.log(fileMessage, error);
});

var cancelResult = channel.cancelUploadingFileMessage(sentFileMessage.reqId);
console.log(cancelResult);

Share an encrypted file with other participants

This feature encrypts all file messages sent by a channel participant with a master key when saved on SendBird server. This encrypted file has its own access URL, and only participants with the master key can decrypt the file and open it.

As this is one of SendBird's Premium Features, please contact our sales team for further assistance. This feature will also require customized implementation efforts from your side.


Spam flood protection

This feature allows you to customize the number of messages a participant can send in an open channel per second. By doing so, all excess messages will be deleted and only the number of messages allowed to be sent per participant per second will be delivered. This feature protects your application from some participants spamming others in the channel with the same messages.

Note: Our default system setting is 5 messages per second. This limit can be manually adjusted only by our side. You can contact our engineering team for further assistance on this setting. As this is one of SendBird's Premium Features, please first contact our sales team for further assistance.


Smart throttling

You can use this feature to customize the number of messages displayed in an open channel per second. By doing so, you can adjust the pace of the conversation in a chat so that the participants can read the messages more clearly. In fact, each participant's channel will display the messages (s)he has sent and those that other participants have sent up to this limit in chronological order.

Note: Our default system setting is 5 messages per second. If you are using this feature, you can adjust the limit from our Dashboard: Settings > Messages > Smart Throttling. As this is one of SendBird's Premium Features, please contact our sales team for further assistance.


Message auto-translation

This feature is not available under the Free plan. Contact our sales team if you want to implement this functionality.

SendBird makes it possible for messages to be sent in different languages through its auto-translation feature. Pass in a List of language codes to sendUserMessage() to request translated messages in the corresponding languages.

var targetLangList = ["es", "ko"];

channel.sendUserMessage(MESSAGE, DATA, CUSTOM_TYPE, targetLangList, function(message, error){
    if (error) {
        return;
    }

    // onSent
});

You can obtain translations of a message with userMessage.translations. This returns an object containing the language codes and translations.

var channelHandler = new sb.ChannelHandler();

channelHandler.onMessageReceived = function (channel, message) {
    var esTranslation = message.translations["es"];

    // Display translation in UI.
};

sb.addChannelHandler(UNIQUE_CHANNEL_ID, channelHandler);