会话已读回执

大约 2 分钟

会话已读回执

会话已读回执指接收方进入会话页面，阅读会话中的所有消息后，调用接口向服务器发送会话已读回执，服务器将该回执回调给消息发送方，消息发送方将会收到会话已读回调。在多端多设备登录下，接收方的其他设备也会收到该回调。

目前，单聊和群组聊天支持会话已读回执。本文介绍如何使用环信即时通讯 IM HarmonyOS SDK 实现会话已读回执功能。

会话已读回执的效果示例，如下图所示：

技术原理

单聊会话已读回执实现的流程如下：

设置 ChatOptions#setRequireReadAck 为 true 开启已读回执功能。
消息接收方进入会话页面，阅读消息后，调用 ackConversationRead 方法发送会话已读回执。
消息发送方通过监听 onConversationRead 回调接收会话已读回执。

前提条件

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

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

实现方法

参考以下步骤在单聊中实现会话已读回执：

开启已读回执功能，即 SDK 初始化时设置 ChatOptions#setRequireReadAck 为 true。

// 设置是否需要消息已读回执，设为 `true`。
options.setRequireReadAck(true);

接收方发送会话已读回执。

消息接收方进入会话页面，查看会话中是否有未读消息。若有，调用 ackConversationRead 方法发送会话已读回执，没有则不发送。

若会话中存在多条未读消息，建议调用该方法，因为若调用发送消息已读回执方法 ackMessageRead，则需要调用多次。

ChatClient.getInstance().chatManager()?.ackConversationRead(conversationId);

消息发送方监听会话已读回执的回调。

同一用户 ID 登录多设备的情况下，用户在一台设备上发送会话已读回执，其他设备会收到 onConversationRead 回调。

提示

对于群组聊天，会话已读回执只用于清空服务端的群组会话的未读数，消息发送方不会通过 onConversationRead 回调收到会话已读回执。

let conversationListener: ConversationListener = {
  onConversationRead: (from: string, to: string): void => {
    // 会话已读回调
  }
}
ChatClient.getInstance().chatManager()?.addConversationListener(conversationListener);