/ SDKs / Flutter
SDKs
Chat SDKs Flutter v4
Chat SDKs Flutter
Chat SDKs
Flutter
Version 4
Home
/
Chat
/
SDKs
/
Flutter
/
Event handler

Add or remove a connection event handler

Copy link

To detect changes in the connection status of a client app, add a connection event handler with its unique user-defined ID by calling 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 view controller.

Connection event types

Copy link

List of connection events

Copy link
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 connect() 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

Copy link

The following code shows a full set of supported event callbacks with their parameters and how to add a connection event handler to the SendbirdChat class.

class MyConnectionHandler extends ConnectionHandler {
  @override
  void onConnected(String userId) {}

  @override
  void onDisconnected(String userId) {}

  @override
  void onReconnectStarted() {}

  @override
  void onReconnectSucceeded() {}

  @override
  void onReconnectFailed() {}
}

SendbirdChat.addConnectionHandler('UNIQUE_HANDLER_ID', MyConnectionHandler());

Remove a connection event handler

Copy link

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

SendbirdChat.removeConnectionHandler('UNIQUE_HANDLER_ID');
On this page
Connection event typesAdd a connection event handlerRemove a connection event handler