/ SDKs / JavaScript

SDKs

Overview
- Getting started
- Send first message
- Environment-specific implementation
- User
- Overview
- - Retrieving and updating user information
  - Retrieve the online status of a user
  - Update user profile
  - Retrieve the latest information on participants
- - Managing user metadata
  - Manage user metadata
- Channel
- Overview
- - Creating a channel
  - Create a channel
- - Managing operators
  - Register and remove operators
- - Joining and leaving a channel
  - Enter and exit an open channel
  - Join and leave a group channel
- - Retrieving channels
  - Retrieve a list of channels
  - Retrieve a channel by URL
- - Inviting users to a group channel
  - Invite users as members
  - Accept or decline an invitation
- - Categorizing channels
  - Categorize channels by custom type
- - Moderating a channel
  - Freeze and unfreeze a channel
- - Managing channel metadata
  - Manage channel metadata
- - Managing channel metacounters
  - Manage channel metacounters
- Message
- Overview
- - Receiving messages through event handler
  - Receive messages in an open channel
  - Receive messages in a group channel
- - Using message threading
  - Create a message thread
  - List replies in a message thread
- - Retrieving messages
  - Retrieve a list of messages
  - Retrieve a message
- - Searching messages in a group channel
  - Search messages by a keyword
- - Managing scheduled messages in group channel
  - Create a scheduled message
  - Retrieve a scheduled message
  - Update a scheduled message
  - Cancel a scheduled message
  - Send a scheduled message immediately
  - List all scheduled messages
  - Retrieve the total number of scheduled messages
- - Managing pinned messages in group channels
  - Pin a message
  - Unpin a message
  - List pinned messages
- - Listing changelogs
  - List changelogs of messages
- - Marking messages as read in a group channel
  - Mark messages as read
- - Marking messages as delivered in a group channel
  - Mark messages as delivered
- - Mentioning other users in a message
  - Mention other users in a message
- - Retrieving unread counts in a group channel
  - Unread messages in a channel
  - Unread messages in all channels
  - Unread channels
  - Members who haven't received a message
  - Members who haven't read a message
  - Unread items
- - Categorizing messages
  - Categorize messages by custom type
- - Adding extra data to a message
  - Add extra data to a message
- - Translating messages
  - Auto-translate messages
  - Translate messages on-demand
  - Translation engine
- Application
- Overview
- - Authenticating a user
  - Authentication
- - Understanding rate limits
  - Rate limits
- Event handler
- Overview
- - Managing channel event handlers
  - Add or remove a channel event handler
- - Managing connection event handlers
  - Add or remove a connection event handler
- - Managing user event handlers
  - Add or remove a user event handler
- Push notifications
- Overview
- - Configuring preferences
  - Set up push notifications
  - Push notification preferences
  - Push notification content templates
  - Push notification translation
- Report
- Overview
- - Creating a report
  - Report a message, user, or channel
- Local caching
- Overview
- - Using group channel collection
  - Group channel collection
- - Using message collection
  - Message collection
Migrating to Sendbird
- Migration guide
- Migration guide
- Collection migration guide
Deprecated
Error codes
Logger

Chat SDKs JavaScript v4

Chat SDKs JavaScript

Chat SDKs

JavaScript

Version 4

/

/

/

/

Add or remove a connection event handler

To detect changes in the connection status of a client app, add a connection event handler with its UNIQUE_HANDLER_ID by calling sb.addConnectionHandler().

If you want to stay informed of changes related to the the Sendbird server connection status and notify the changes to different client apps, define and register multiple connection event handlers using the UNIQUE_HANDLER_ID.

Connection event types

List of connection events

Method	Invoked when	Notified devices
onConnected()	SDK has connected to the Sendbird server successfully.	The device that successfully connected to the server and started the session.
onDisconnected()	SDK has disconnected and lost the session.	The device explicitly disconnected through `sb.disconnect()`.
onReconnectStarted()	SDK has started reconnecting to the Sendbird server.	The device where `sb.reconnect()` was automatically called by the Chat SDK or manually by the client app.
onReconnectSucceeded()	SDK has succeeded in reconnecting to the Sendbird server.	The device that successfully reconnected to the server.
onReconnectFailed()	SDK has failed to reconnect to the Sendbird server.	The device that failed to reconnect to the server.

Add a connection event handler

The following code shows a full set of supported event callbacks and how to add a connection event handler to the unique SendbirdChat instance.

JavaScriptTypeScript

const connectionHandler = new ConnectionHandler({
  onConnected: () => {},
  onDisconnected: () => {},
  onReconnectStarted: () => {},
  onReconnectSucceeded: () => {},
  onReconnectFailed: () => {},
});

sb.addConnectionHandler(UNIQUE_HANDLER_ID, connectionHandler);

Remove a connection event handler

The following code shows how to remove the connection event handler.

JavaScriptTypeScript

sb.removeConnectionHandler(UNIQUE_HANDLER_ID);

On this page

Connection event types Add a connection event handler Remove a connection event handler

Sample app