Get total unread count

Query the aggregate unread message count across all conversations belonging to the authenticated account. This method accepts no parameters. Avoid summing only the unreadCount values of conversations currently loaded in your visible paginated list, as conversations that have not yet been paged into memory may also hold unread messages.

Code example

import { getTotalUnreadMsgCount } from '@/uni_modules/unix-openim-sdk'

const totalUnread = await getTotalUnreadMsgCount()
if (totalUnread != null) {
  updateApplicationBadge(totalUnread)
}

Return value

The Promise resolves with a number | null value representing the aggregate unread message count at the time of invocation.

State changes after the call

This call is a local read-only query that retrieves the current unread total without triggering events.

Listen for total unread count changes

Subscribe centrally to total unread count transitions. The callback receives the newly computed aggregate unread count directly as a number.

import {
  off,
  onTotalUnreadMessageCountChanged,
} from '@/uni_modules/unix-openim-sdk'

const handleTotalUnreadChanged = (count: number) => {
  updateApplicationBadge(count)
}

const totalUnreadSubscription = onTotalUnreadMessageCountChanged(
  handleTotalUnreadChanged,
)

function removeTotalUnreadListener() {
  off(totalUnreadSubscription)
}

Invoke removeTotalUnreadListener() when the component unmounts, when logging out, or when switching accounts. Upon re-logging in or network reconnection, invoke getTotalUnreadMsgCount() to calibrate badges against the latest server state. To synchronize this count with operating system application icons, see Set app badge.