Skip to main content

Chat / JavaScript

Current version: v4

Switch versions

Overview
- Getting started
- Send first message
- Migration guide
- User
- Overview
- - Retrieving and updating user information
  - Retrieve the online status of a user
  - Update user profile
  - Retrieve the latest information on participants
- - Managing user metadata
  - Manage user metadata
- Channel
- Overview
- - Creating a channel
  - Create a channel
- - Managing operators
  - Register and remove operators
- - Joining and leaving a channel
  - Enter and exit an open channel
  - Join and leave a group channel
- - Retrieving channels
  - Retrieve a list of channels
  - Retrieve a channel by URL
- - Inviting users to a group channel
  - Invite users as members
  - Accept or decline an invitation
- - Categorizing channels
  - Categorize channels by custom type
- - Moderating a channel
  - Freeze and unfreeze a channel
- - Managing channel metadata
  - Manage channel metadata
- - Managing channel metacounter
  - Manage channel metacounter
- Message
- Overview
- - Receiving messages through event handler
  - Receive messages in an open channel
  - Receive messages in a group channel
- - Using threaded messages
  - Reply to a message in a channel
  - List replies of a parent message
- - Retrieving a message
  - Retrieve a message
  - Retrieve the last message of a group channel
  - Search messages by a keyword
- - Loading messages
  - Load previous messages
  - Load messages by timestamp or message ID
- - Listing messages
  - List changelogs of messages
  - Smart throttling in a channel
- - Marking messages as read in a group channel
  - Mark messages as read
- - Marking messages as delivered in a group channel
  - Mark messages as delivered
- - Mentioning other users in a message
  - Mention other users in a message
- - Getting statistics on unread messages in a group channel
  - Retrieve number of unread messages in a channel
  - Retrieve number of unread messages in all channels
  - Retrieve number of channels with unread messages
  - Retrieve number of members who haven't received a message
  - Retrieve number of members who haven't read a message
  - Retrieve number of unread items
- - Categorizing messages
  - Categorize messages by custom type
- - Adding extra data to a message
  - Add extra data to a message
- - Translating messages
  - Auto-translate messages
  - Translate messages on-demand
  - Translation engine
- Application
- Overview
- - Authenticating a user
  - Authentication
- - Understanding rate limits
  - Rate limits
- Event handler
- Overview
- - Managing channel event handler
  - Add or remove a channel event handler
- - Managing connection event handler
  - Add or remove a connection event handler
- - Managing user event handler
  - Add or remove a user event handler
- Notifications
- Overview
- - Configuring preferences
  - Set up push notifications
  - Notification preferences
  - Push notification content templates
  - Push notification translation
- Report
- Overview
- - Creating a report
  - Report a message, user, or channel
- Local caching
- Overview
- - Using group channel collection
  - Group channel collection
- - Using message collection
  - Message collection
Deprecated
Error codes
Logger

Chat JavaScript v4

Chat JavaScript

Chat

JavaScript

Home

/

Chat

/

JavaScript

/

Message

This is the new Docs for Chat SDK v4 for JavaScript. To see the previous Docs, click here.

Retrieve number of unread items

You can retrieve the count of a user's unread messages, unread mentioned messages, or received invitations in group channels and Supergroup channels. You can use this action to display the count in the UI and prompt the user to check unread messages and invitations. This is only available for group channels and Supergroup channels.

To get the count, create a UnreadItemCountParams instance by setting UnreadItemKey in keys. Then pass it to the getUnreadItemCount() method.

The following table lists acceptable values for UnreadItemKey.

Value	Description
GROUP_CHANNEL_INVITATION_COUNT	The number of invitations the user has received for all group channels and Supergroup channels.
GROUP_CHANNEL_UNREAD_MENTION_COUNT	The number of messages the user was mentioned but hasn't read in all group channels and Supergroup channels.
GROUP_CHANNEL_UNREAD_MESSAGE_COUNT	The number of messages the user hasn't read in all group channels and Supergroup channels.
NONSUPER_INVITATION_COUNT	The number of invitations the user has received for all group channels channels.
NONSUPER_UNREAD_MENTION_COUNT	The number of messages the user was mentioned but hasn't read in all group channels.
NONSUPER_UNREAD_MESSAGE_COUNT	The number of messages the user hasn't read in all group channels channels.
SUPER_INVITATION_COUNT	The number of invitations the user has received for all Supergroup channels.
SUPER_UNREAD_MENTION_COUNT	The number of messages the user was mentioned but hasn't read in all Supergroup channels.
SUPER_UNREAD_MESSAGE_COUNT	The number of messages the user hasn't read in all Supergroup channels.

const params: UnreadItemCountParams = {
    keys: [
        UnreadItemKey.GROUP_CHANNEL_UNREAD_MENTION_COUNT,
        UnreadItemKey.GROUP_CHANNEL_UNREAD_MESSAGE_COUNT,
    ],
};
const unreadItemCount: UnreadItemCount = await sb.getUnreadItemCount(params);

Sample app