Chat / Android
Chat Android v4
Chat Android
Chat
Android
Home
/
Chat
/
Android
/
Event handler
This is the new Docs for Chat SDK v4 for Android. To see the previous Docs, click here.

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

MethodInvoked whenNotified 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.

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.

SendbirdChat.removeConnectionHandler(UNIQUE_HANDLER_ID);