Chat / Flutter
Current version: v3
Chat Flutter v3
Chat Flutter
Chat
Flutter
Home
/
Chat
/
Flutter
/
Message

Retrieve number of unread items

You can retrieve the count of a user's unread messages, unread mentioned messages, or invitations received in group channels and Supergroup channels. You can use this action to display the number of unread items in the UI so that users may check them. This is only available in group channels and Supergroup channels.

To get the count, use the getUnreadItemCount() method with UnreadItemKey.

final result = await sdk.getUnreadItemCount([
    UnreadItemKey.nonSuperGroupChannelUnreadMessageCount,
  ]);

  expect(result.nonSuperGroupChannelUnreadMessageCount, equals(2));

The following table lists some of the properties in UnreadItemKey. To see the comprehensive list of all properties in UnreadItemKey, see the API reference.

Property nameDescription

groupChannelInvitationCount

The number of invitations from group channels and Supergroup channels the user has received.

groupChannelUnreadMentionCount

The number of messages in group channels and Supergroup channels where the user was mentioned but the user hasn't read.

groupChannelUnreadMessageCount

The number of messages in group channels and Supergroup channels the user hasn't read.

nonSuperGroupChannelInvitationCount

The number of invitations from group channels the user has received.

nonSuperGroupChannelUnreadMentionCount

The number of messages in group channels where the user was mentioned but the user hasn't read.

nonSuperGroupChannelUnreadMessageCount

The number of messages in group channels the user hasn't read.

superGroupChannelInvitationCount

The number of invitations from Supergroup channels the user has received.

superGroupChannelUnreadMentionCount

The number of messages in Supergroup channels where the user was mentioned but the user hasn't read.

superGroupChannelUnreadMessageCount

The number of messages in Supergroup channels the user hasn't read.