导入和插入消息

本文介绍环信即时通讯 IM HarmonyOS SDK 如何在本地导入和插入消息。

技术原理

环信即时通讯 IM HarmonyOS SDK 支持提供 ChatManager 类和 Conversation 类支持在本地导入和插入消息，其中包含如下主要方法：

• ChatManager#importMessages：批量导入消息到数据库；
• Conversation#insertMessage：在本地指定会话中插入一条消息。

前提条件

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

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

实现方法

批量导入消息到数据库

如需在本地会话中批量插入消息，可以构造 ChatMessage 对象并调用 ChatManager#importMessages。当前登录用户只能导入自己发送或接收的消息；导入后，SDK 会按照消息中的时间戳将其添加到对应会话。建议每次导入不超过 1,000 条消息。

自 HarmonyOS SDK 1.14.0 起，可以通过 ChatOptions#setRegardImportedMsgAsRead 配置是否将导入的消息视为已读。该配置默认为 false，设置为 true 时，导入的消息将被视为已读。该配置仅在初始化 SDK 前设置有效，可以调用 ChatOptions#regardImportedMsgAsRead 获取当前配置。

const options = new ChatOptions({
  appKey: 'your-org#your-app'
});

// 将导入的消息视为已读。
options.setRegardImportedMsgAsRead(true);

// 获取当前配置。
const regardImportedMsgAsRead = options.regardImportedMsgAsRead();

ChatClient.getInstance().init(context, options);

初始化 SDK 后，调用以下方法批量导入消息：

ChatClient.getInstance().chatManager()?.importMessages(msgs);

插入消息

如果你需要在本地会话中加入一条消息，比如收到某些通知消息时，可以构造一条消息写入会话。

例如插入一条无需发送但有需要显示给用户看的内容，类似 “XXX 撤回一条消息”、“XXX 入群”、“对方正在输入” 等。

消息会根据消息中的 Unix 时间戳插入本地数据库，SDK 会更新会话的 latestMessage 等属性。

示例代码如下：

// 将消息插入到指定会话中。
let conversation = ChatClient.getInstance().chatManager()?.getConversation(conversationId);
if (!conversation) {
    return;
}
conversation.insertMessage(message);

// 直接插入消息。
ChatClient.getInstance().chatManager()?.saveMessage(message);