浏览 SDKs · React Native
平台
SDKsReact Native

获取消息总未读数

获取消息总未读数。

复制

获取当前登录账号所有会话的未读消息总数。请直接使用该接口查询或监听总未读数变化,不要通过累加当前已分页加载的会话 unreadCount 来计算总数,否则会遗漏未加载会话中的未读消息。

const totalUnread = await OpenIMSDK.getTotalUnreadMsgCount();

返回结果

调用完成后返回 number 类型的总未读数。

事件监听

应用处于前台时,可通过 OnTotalUnreadMessageCountChanged 监听总未读数变化:

function handleTotalUnreadChanged(totalUnread: number) {
  // ...
}

// 设置监听
OpenIMSDK.on(OpenIMEvent.OnTotalUnreadMessageCountChanged, handleTotalUnreadChanged);

// 取消监听
OpenIMSDK.off(OpenIMEvent.OnTotalUnreadMessageCountChanged, handleTotalUnreadChanged);

组件销毁、退出登录或切换账号时,应使用同一函数引用取消监听。

需要把该数值同步给 SDK 的推送角标状态时,参见设置应用角标数量。