JavaScript
Authentication

Authentication

In order to use the features of the Chat SDK for JavaScript in your client apps, a SendBird instance should be initiated in each client app through user authentication with Sendbird server. The instance communicates and interacts with the server based on an authenticated user account, and is allowed to use the Chat SDK's features. This page explains how to authenticate your user with the server.


Initialize the Chat SDK with APP_ID

To use our chat features, you should initialize a SendBird instance by passing the APP_ID of your Sendbird application to the new SendBird() as a parameter. The new SendBird() must be called once across your client app. Typically, initialization is implemented in the user login view.

Light Color Skin
Copy
var sb = new SendBird({appId: APP_ID});

Connect to Sendbird server with a user ID

By default, Sendbird server can authenticate a user just by a unique user ID. Then the server queries the database to check for a match upon the request for connection. If no matching user ID is found, the server creates a new user account with the user ID. The ID should be unique within a Sendbird application to be distinguished from others, such as a hashed email address or phone number in your service.

This authentication procedure is useful when in development or if your service doesn't require additional security.

Note: Go to the Event Handler page to learn more about the usages of the Chat SDK's handlers and callbacks.

Light Color Skin
Copy
sb.connect(USER_ID, function(user, error) {});

Note: You must connect to Sendbird server before calling any methods through the Chat SDK (apart from initializing your SendBird instance). If you attempt to call a method without connecting, a CONNECTION_REQUIRED (800101) error would be returned.


Connect to Sendbird server with a user ID and an access token

Using Chat Platform API, you can create a user along with their own access token, or issue an access token for an existing user. Once an access token is issued, a user is required to provide the access token in the sb.connect() method which is used for logging in.

  1. Using the Chat API, create a Sendbird user account with the information submitted when a user signs up or in to your service.
  2. Save the user ID along with the issued access token to your persistent storage which is securely managed.
  3. When the user attempts to log in to the Sendbird application, load the user ID and access token from the storage, and then pass them to the sb.connect() method.
  4. Periodically replacing the user's access token is recommended to protect the account.

Note: From Settings > Application > Security > Access token permission setting in your dashboard, you are able to prevent users without an access token from logging in to your Sendbird application or restrict their access to read and write messages.

Light Color Skin
Copy
sb.connect(USER_ID, ACCESS_TOKEN, function(user, error) {});

Note: For security reasons, you can also use a session token when a user logs in to Sendbird server instead of an access token. Go to the Access token vs. Session token section from the Chat API guide to learn more.


Disconnect from Sendbird server

A user should be disconnected from Sendbird server when they no longer need to receive messages from an online state. However, the user will still receive push notifications for new messages from group channels they've joined.

When disconnected, all types of event handlers in a user's client app registered by the sb.addChannelHandler() or sb.addConnectionHandler() stop receiving event callbacks from the server. Then, all internally cached data in the client app, such as the channels that are cached when the sb.OpenChannel.getChannel() or sb.GroupChannel.getChannel() is called, are also flushed.

Note: By default, most of the data related to users, channels, and messages are internally cached in the SendBird instance of a user's client app, which are retrieved by the corresponding query instances or received through the event handlers.

Light Color Skin
Copy
sb.disconnect(function(){
    // A current user is discconected from Sendbird server.
});

Update user profile

Using the updateCurrentUserInfo() method, you can update a user's nickname and profile image with a URL.

Light Color Skin
Copy
sb.updateCurrentUserInfo(NICKNAME, PROFILE_URL, function(response, error) {
    if (error) {
        return;
    }   
});

Or, you can upload a profile image directly using the updateCurrentUserInfoWithProfileImage() method.

Light Color Skin
Copy
sb.updateCurrentUserInfoWithProfileImage(NICKNAME, PROFILE_FILE, function(response, error) {
    if (error) {
        return;
    }   
});

Note: A user's profile image can be a JPG (.jpg), JPEG (.jpeg), or PNG (.png) file of up to 25 MB.