会话未读数

你可以查看本地所有会话或指定会话的未读消息数，并针对会话的未读消息数清零。

前提条件

开始前，请确保满足以下条件：

• 完成 SDK 初始化并连接到服务器，详见 快速开始。
• 了解环信即时通讯 IM API 的使用限制，详见 使用限制。

技术原理

环信即时通讯 IM Android SDK 通过 EMChatManager和 EMConversation 类实现对本地会话的未读消息数的管理，其中核心方法如下：

• EMChatManager#getUnreadMessageCount：获取本地所有会话的未读消息数。
• EMConversation#getUnreadMsgCount：获取本地指定会话的未读消息数。
• EMChatManager#markAllConversationsAsRead：将本地所有会话的未读消息数清零。
• EMConversation#markAllMessagesAsRead：对于本地指定会话的未读消息数清零。
• EMConversation#markMessageAsRead：将指定会话的单条未读消息置为已读。
• EMConversation#markMessagesAsReadWithTimestamp：将指定会话中指定时间点及以前的未读接收消息批量标记为已读。

实现方法

获取所有会话的未读消息数

你可以调用 getUnreadMessageCount 方法获取本地所有会话的未读消息数量，示例代码如下：

EMClient.getInstance().chatManager().getUnreadMessageCount();

获取指定会话的未读消息数

你可以调用 getUnreadMsgCount 获取本地指定会话的未读消息数，示例代码如下：

EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
conversation.getUnreadMsgCount();

将所有会话的未读消息数清零

你可以调用 markAllConversationsAsRead 方法将本地所有会话设为已读，即将所有会话的未读消息数清零，示例代码如下：

EMClient.getInstance().chatManager().markAllConversationsAsRead();

指定会话的未读消息数清零

你可以调用 markAllMessagesAsRead 方法对指定会话的未读消息数清零，示例代码如下：

EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
conversation.markAllMessagesAsRead();

将指定会话的单条未读消息置为已读

你可以调用 markMessageAsRead 方法将指定会话的单条未读消息置为已读。

EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
conversation.markMessageAsRead(messageId);

按时间点批量标记消息已读

自 SDK 4.26.0 起，你可以调用 EMConversation#markMessagesAsReadWithTimestamp(long timestamp)，将指定会话中时间戳小于或等于 timestamp 的未读接收消息标记为已读，并相应减少会话未读数。例如，用户已阅读到某条消息时，可以只清除该消息及之前消息的未读状态，保留之后消息的未读状态。

• 返回值：操作成功返回 true；时间戳无效或数据库操作失败返回 false。
• 时间判断与消息排序配置 EMOptions#setSortMessageByServerTime(boolean) 一致：按服务器时间排序时使用消息服务器时间，否则使用消息本地时间。
• 该操作仅修改本地未读的接收消息，不向服务器发送已读回执。如需通知发送方消息已读，请另行发送已读回执。

EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
// 已阅读到的消息，应属于当前会话。
EMMessage lastReadMessage = conversation.getMessage(messageId);
if (lastReadMessage != null) {
    boolean sortByServerTime = EMClient.getInstance().getOptions().isSortMessageByServerTime();
    long timestamp = sortByServerTime
            ? lastReadMessage.getMsgTime()
            : lastReadMessage.localTime();
    // `timestamp`：指定时间点（包含该时间点），Unix 时间戳，单位为毫秒，必须大于 `0`。        
    boolean success = conversation.markMessagesAsReadWithTimestamp(timestamp);
    if (success) {
        int unreadCount = conversation.getUnreadMsgCount();
        // 根据 unreadCount 更新会话未读数展示。
    }
}