/ SDKs / Flutter
SDKs
Chat SDKs Flutter v4
Chat SDKs Flutter
Chat SDKs
Flutter
Version 4

Add or remove a user event handler

Copy link

To receive information about events related to users connected to the Sendbird server, add a user event handler with its unique user-defined ID by calling addUserEventHandler().

If you want to stay informed of changes related to users and notify users' client apps of these changes, define and register multiple user event handlers to each view controller.


User event types

Copy link

List of user events

Copy link

The onTotalUnreadMessageCountChanged() attribute is turned off by default. Contact us if you wish to use this feature.

MethodInvoked whenNotified devices

onTotalUnreadMessageCountUpdated()

A user has read messages in the joined group channels and there is an update on the total number of the user's unread messages.

The user's devices with running client apps. The devices will be notified with the total number of unread messages along with a collection of the number of unread messages by custom channel type.


Add a user event handler

Copy link

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

class MyUserEventHandler extends UserEventHandler {
  @override
  void onFriendsDiscovered(List<User> friends) {}

  @override
  void onTotalUnreadMessageCountUpdated(
    int totalCount,
    Map<String, int> customTypesCount,
  ) {}
}

SendbirdChat.addUserEventHandler('UNIQUE_HANDLER_ID', MyUserEventHandler());

Remove a user event handler

Copy link

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

SendbirdChat.removeUserEventHandler('UNIQUE_HANDLER_ID');