导入和插入消息

大约 3 分钟

导入和插入消息

功能说明

本文介绍环信即时通讯 IM iOS SDK 如何将消息导入本地数据库,以及如何在本地会话中插入消息。

这些操作仅更新当前设备上的本地消息和会话数据,不会将消息发送给会话对端,也不会向服务器上传消息或同步到当前账号的其他设备。常见使用场景包括迁移历史消息、恢复本地消息记录,以及插入撤回提示、入群通知等仅用于本地展示的消息。

iOS SDK 提供以下方式:

  • 批量导入消息:调用 importMessages,将当前用户发送或接收的多条消息异步导入本地数据库,但不会更新对应会话的latestMessage 等属性。
  • 向指定会话插入消息:调用 insertMessage,按照消息中的 Unix 时间戳将消息插入指定会话,并更新会话的latestMessage 等属性。消息的会话 ID 必须与目标会话 ID 一致。

批量导入消息时,如果对应会话尚无最新消息记录,从本地数据库加载会话且过滤空会话时,该会话会被过滤,不会出现在返回的会话列表中。EMOptions.loadEmptyConversations 默认为 NO,即不加载空会话。

因此,建议按会话划分待导入的消息,将每个会话中按消息时间排序的最新一条消息预留出来,其余消息通过 importMessages 批量导入,待批量导入完成后,再通过对应会话的 insertMessage 插入预留的消息,以更新会话信息。插入前应获取或创建对应会话。“最新”以 SDK 当前消息排序配置使用的时间戳为准。例如,同一个会话有 10:00、10:01 和 10:02 三条待导入的消息,可先通过 importMessages 导入前两条,再通过 insertMessage 插入 10:02 的消息。不要先将三条消息全部批量导入,再重复插入 10:02 的消息,否则 SDK 会因消息已存在而直接返回,不会更新会话信息。

前提条件

  • 完成 SDK 初始化并登录,详见 快速开始。
  • 了解环信即时通讯 IM 的使用限制,详见 使用限制。

批量导入消息到数据库

如果需要批量导入消息到本地会话,可以调用 importMessages,构造 EMChatMessage 对象并将消息导入本地数据库。

当前用户只能导入自己发送或接收的消息。导入后,消息保存在本地数据库中,但不会更新对应会话的latestMessage 等属性。

推荐一次导入 1,000 条以内的数据。

[[EMClient sharedClient].chatManager importMessages:messages completion:^(EMError *error) {
    // 处理导入结果。
}];

提示

EMOptions#regardImportMessagesAsRead 不控制本地批量导入消息的已读状态。该配置适用于通过 服务端消息导入接口 导入、之后由客户端从服务器拉取的历史消息。调用本地导入接口前,应确保 SDK 已初始化,且当前用户的本地数据库已打开。

插入消息

如果需要在本地会话中加入一条无需发送、仅用于本地展示的消息,例如“XXX 撤回一条消息”“XXX 入群”或“对方正在输入”等,可以调用 insertMessage,将消息插入指定的本地会话。

消息会按照其中的 Unix 时间戳插入本地数据库,SDK 同时更新会话的 latestMessage 等属性。调用前应确保消息的会话 ID 与目标会话 ID 一致。

EMConversation *conversation = [[EMClient sharedClient].chatManager getConversation:conversationId type:type createIfNotExist:YES];
EMError *error = nil;
[conversation insertMessage:message error:&error];

接口列表

API 名称所属模块/类型说明
importMessagesIEMChatManager异步批量导入消息。
getConversationIEMChatManager获取或创建本地会话。
insertMessageEMConversation同步向本地会话插入消息。
上次编辑于: