JavaScript
Application

Application

Before you start building your chat, it is important to understand that your Sendbird application has core functionalities to maintain chat service stability and basic features for application management. This page presents how you can use a Sendbird application in your app to ensure optimal performance.


Default settings

To prevent abnormal user activity, a Sendbird application has the following limits on the number of messages per second which a user can send and an open channel can display.

Imposed onLimitIf exceeded

User

5 messages per second

Excess messages are neither sent to the channel nor saved in the database but are displayed in the user's channel view.

Open channel

5 messages per second

Excess messages are not displayed, but saved in the database.

* This setting is not effective in a group channel.

The limits are the default settings of our premium features, spam flood protection and smart throttling, which can only be adjusted by Sendbird. Contact our sales team if you require assistance.


Manage connections with Sendbird server

Unlike the Chat SDKs for iOS and Android, the Chat SDK for JavaScript doesn't manage a connection to Sendbird server when the foreground and background states of your web app changes on a various types of devices. In that context, you should call the connect() or disconnect() methods explicitly depending on how you implement your use cases.

One user ID can make connections to up to 30 devices or browsers simultaneously. All connections from one user ID are counted and reflected in your application’s concurrent connections. Since they are used to calculate your service billing, caution is advised.


Retrieve a list of users

You can retrieve a list of all or certain users in your Sendbird application using an ApplicationUserListQuery instance. The next() method returns a list of User objects which contain information on users within the application.

Light Color Skin
Copy
// Retrieving all users
var sb = SendBird.getInstance();
var applicationUserListQuery = sb.createApplicationUserListQuery();
applicationUserListQuery.next(function(users, error) {
    if (error) {
        return;
    }
});

With the several different types of filters the ApplicationUserListQuery instance provides, you can retrieve a list of specific users that match the set values in the filters. Currently the ApplicationUserListQuery instance supports the following three filters:

NameFilters...

UserIdsFilter

Users who are using the specified user IDs. Specifying the userIdsFilter option enables this filter.

MetaDataKeyFilter

Users with metadata containing an item with the specified key and values. Specifying the metaDataKeyFilter option along with the metaDataValuesFilter below enables this filter.

MetaDataValuesFilter

Users with metadata containing an item with the specified key and values. Specifying the metaDataValuesFilter option along with the metaDataKeyFilter above enables this filter.

NicknameStartsWithFilter

Users whose nicknames start with the specified value. Specifying the nicknameStartsWithFilter option enables this filter.

Note: We recommend you set the maximum number of user IDs to 250 in the UserID filter. If exceeded, your query may receive an HTTP 414 error indicating that the submitted request data is longer than Sendbird server is willing to interpret.

Light Color Skin
Copy
// Retrieving certain users using the UserID filter
var applicationUserListQueryByIds = sb.createApplicationUserListQuery();
applicationUserListQueryByIds.userIdsFilter = ['Harry', 'Jay', 'Jin'];
applicationUserListQueryByIds.next(function(users, error) {
    if (error) {
        return;
    }
});

// Retrieving certain users using the MetaDataKey and MetaDataValue filter
var applicationUserListQueryByMetaData = sb.createApplicationUserListQuery();
applicationUserListQueryByMetaData.metaDataKeyFilter = 'hobby';
applicationUserListQueryByMetaData.metaDataValuesFilter = ['movie', 'book', 'exercise'];
applicationUserListQueryByMetaData.next(function(users, error) {
    if (error) {
        return;
    }
});

// Retrieving certain users using the NicknameStartsWith filter
var applicationUserListQueryByNicknameStartsWith = sb.createApplicationUserListQuery();
applicationUserListQueryByNicknameStartsWith.nicknameStartsWithFilter = 'Ja';
applicationUserListQueryByNicknameStartsWith.next(function(users, error) {
    if (error) {
        return;
    }
});

Block and unblock other users

A user can register other users within an application as friends, start an instant 1-on-1 group chat with a friend, and invite friends to existing group channels. On the other hand, a user can block specific users to stop receiving further messages from them in 1-on-1 group channels and notifications of their messages in 1-on-N group channels. You can choose whether or not users can view which users they have blocked in the channel UI.

A Sendbird application provides two blocking options: including or excluding blocked users when sending invitations and turning on/off push notifications from blocked users. The previous block modes are now deprecated and only supported for customers who have been using them from before.

  • Including or excluding blocked users when sending invitations: determines whether or not to automatically filter out blocked users when a user invites a group of users to a new group channel. The value of this option can be adjusted only from our side before integrating your Sendbird application to an app. If you want to change the value, contact our sales team for further assistance. (Default: including)
  • Turning on/off push notifications from blocked users: determines whether or not to send push notifications to a user for the messages that blocked users sent in a specific 1-on-N group channel where they are members together. The value of this option can be set individually by channel. If you want to use this option, contact our sales team for further assistance. (Default: off)
1-on-1 group channel
Channel listPush notificationsMessages

A user's channel list will not be updated and rearranged from the blocked user's messages.

A user will not be notified that the blocked user sent a message.

New messages sent from the blocked user will not be delivered to the channel, but are saved in the database and displayed in the blocked user's channel view. The blocked user is not aware of their blocked status. A user can only see the messages that the blocked user has sent before being blocked.

* If the blocked user is unblocked, a user can see all the messages except those that were sent during the blocking period.

1-on-N group channel (group chat)
Channel listPush notificationsMessages

For a blocked user's message, a user's channel list will be updated and rearranged.

A user will be notified of messages from blocked users if push notifications from blocked users is turned on. Otherwise, they will not be notified.

All the messages from blocked users are delivered to the channel. You can choose whether a user can view which users they have blocked in the UI of the channel.

You can allow a uers to block and unblock other users by implementing the following code to your client app.

Light Color Skin
Copy
// Blocking a user
var sb = SendBird.getInstance();
sb.blockUser(USER, function(user, error) {
    if (error) {
        return;
    }
});

Note: You can use the blockUserWithUserId() and unblockUserWithUserId() methods, instead of the blockUser() and unblockUser() methods, as they have same functionalities. Please see our API reference for more information on the bloackUserWithUserId() and unblockUserWithUserID().


Retrieve a list of blocked users

You can retrieve a list of all or certain blocked users in your Sendbird application using a BlockedUserListQuery instance. The next() method returns a list of User objects which contain information on blocked users.

Light Color Skin
Copy
// Retrieving all blocked users
var sb = SendBird.getInstance();
var blockedUserlistQuery = sb.createBlockedUserListQuery();
blockedUserlistQuery.next(function(users, error) {
    if (error) {
        return;
    }
});

With the BlockedUserListQuery's UserID filter, you can retrieve a list of the blocked users that match the user IDs in the filter.

Light Color Skin
Copy
// Retrieving certain blocked users using the UserID filter
var blockedUserListQuery = sb.createBlockedUserListQuery();
blockedUserListQuery.userIdsFilter = ['John', 'Daniel', 'Jeff'];
blockedUserListQuery.next(function(users, error) {
    if (error) {
        return;
    }
});

Check if a user is online

You can check if a certain user is currently connected to Sendbird server.

Light Color Skin
Copy
var sb = SendBird.getInstance();
var ApplicationUserListQuery = sb.createApplicationUserListQuery();
applicationUserListQuery.userIdsFilter = ['Jeff'];
applicationUserListQuery.next(function(users, error) {
    if (error) {
        return;
    }

    if (users[0].connectionStatus === sb.User.ONLINE) {
        // User.connectionStatus consists of NON_AVAILABLE, ONLINE, and OFFLINE.
    }
});