/ SDKs / Android

SDKs

Overview
- Getting started
- Send first message
- Kotlin extension (KTX)
- Migration guide
- Collection migration guide
- 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
- - Managing channels
  - Delete a channel
  - Hide or archive a group channel
  - Refresh all data related to a group channel
- - 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 count 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
- - Marking push notifications as delivered
  - Mark push notifications as delivered
- - Multi-device support
  - Set up push notifications for FCM
  - Set up push notifications for HMS
- 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
Deprecated
Error codes
Logger

Chat SDKs Android v4

Chat SDKs Android

Chat SDKs

Android

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 user-defined ID by calling SendbirdChat.addConnectionHandler().

If you want to stay informed of changes related to the Sendbird server connection status and notify client apps of these changes, define and register multiple connection event handlers to each Activity instance.

Connection event types

List of connection events

Method	Invoked when	Notified devices
onConnected()	The Chat SDK has been connected to the Sendbird server for the first time.	The device that is connected to the Sendbird server.
onDisconnected()	The user has been logged out. It is different from WebSocket disconnection where a client app goes to the background. This handler is called after `SendbirdChat.disconnect()` is called.	The device that is disconnected from the Sendbird server.
onReconnectStarted()	The Chat SDK has started reconnecting to the Sendbird server.	The device where `reconnect()` was automatically called by the Chat SDK or manually by the client app.
onReconnectSucceeded()	The Chat SDK has succeeded in reconnecting to the Sendbird server.	The device that successfully reconnected to the server.
onReconnectFailed()	The Chat 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.

Kotlin

SendbirdChat.addConnectionHandler(
    UNIQUE_HANDLER_ID,
    object : ConnectionHandler {
        override fun onConnected(userId: String) {}

        override fun onDisconnected(userId: String) {}

        override fun onReconnectStarted() {}

        override fun onReconnectSucceeded() {}

        override fun onReconnectFailed() {}
    }
)

Remove a connection event handler

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

Kotlin

SendbirdChat.removeConnectionHandler(UNIQUE_HANDLER_ID);

On this page

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

Sample app