/ SDKs / JavaScript
SDKs
Chat SDKs JavaScript v4
Chat SDKs JavaScript
Chat SDKs
JavaScript
Version 4

Retrieve number of unread items

Copy link

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, create an UnreadItemCountParams instance by setting UnreadItemKey in keys. Then pass it to the getUnreadItemCount() method.

List of parameters

Copy link
Property nameTypeDescription

key

UnreadItemKey

Specifies the key type to filter the channels with the corresponding type.

customTypesFilter

string[]

Specifies the custom channel types to filter channels with the corresponding custom type.

The following table lists the properties in UnreadItemKey.

Property nameDescription

GROUP_CHANNEL_INVITATION_COUNT

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

GROUP_CHANNEL_UNREAD_MENTION_COUNT

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

GROUP_CHANNEL_UNREAD_MESSAGE_COUNT

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

NONSUPER_INVITATION_COUNT

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

NONSUPER_UNREAD_MENTION_COUNT

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

NONSUPER_UNREAD_MESSAGE_COUNT

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

SUPER_INVITATION_COUNT

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

SUPER_UNREAD_MENTION_COUNT

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

SUPER_UNREAD_MESSAGE_COUNT

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

JavaScriptTypeScript
const params = {
    keys: [
        UnreadItemKey.GROUP_CHANNEL_UNREAD_MENTION_COUNT,
        UnreadItemKey.GROUP_CHANNEL_UNREAD_MESSAGE_COUNT,
    ],
    customTypesFilter: ['custom_type_1', 'custom_type_2'],
};
const unreadItemCount = await sb.getUnreadItemCount(params);