文档简介:
环信即时通讯 IM 提供消息漫游功能,即将用户的所有会话的历史消息保存在消息服务器,用户在任何一个终端设备上都能获取到历史信息,使用户在多个设备切换使用的情况下也能保持一致的会话场景。本文介绍用户如何获取和删除服务端的会话和消息。
提示
本文介绍的功能均为增值服务,需在环信即时通讯 IM 管理后台 (opens new window)开通。
技术原理
使用环信即时通讯 IM iOS SDK 可以管理服务端的会话和历史消息。
- getConversationsFromServerByPage 分页获取服务器上保存的会话列表;
- asyncFetchHistoryMessagesFromServer 获取服务器保存的指定会话中的消息;
- removeMessagesFromServerWithTimeStamp/removeMessagesFromServerMessageIds 按消息时间或消息 ID 单向删除服务端的历史消息;
- deleteServerConversation 删除服务器端会话及其历史消息。
前提条件
开始前,请确保满足以下条件:
- 完成 SDK 初始化,并连接到服务器,详见 快速开始。
- 了解环信即时通讯 IM API 的使用限制,详见 使用限制。
实现方法
从服务器分页获取会话列表
对于单聊或群聊,用户发消息时会自动将对方添加到用户的会话列表。
你可以调用 getConversationsFromServerByPage 方法从服务端分页获取会话列表,每个会话包含最新一条历史消息。
提示
- 若使用该功能,需将 SDK 升级至 4.0.0。
- 建议在 app 安装时或本地没有会话时调用该方法,否则调用 getAllConversations 方法即可。
- 获取的会话列表中不包含最新一条消息通过 RESTful 接口发送的会话。若需获取该类会话,需要联系商务开通将通过 RESTful 接口发送的消息写入会话列表的功能。
示例代码如下:
// pageNum:当前页面,从 1 开始。 // pageSize:每页获取的会话数量。取值范围为 [1,20]。
[EMClient.sharedClient.chatManager getConversationsFromServerByPage:pageNum pageSize:pageSize
completion:^(NSArray<EMConversation *> * _Nullable aConversations, EMError * _Nullable aError) { }];
对于使用 getConversationsFromServer 方法未实现分页获取会话的用户,SDK 默认可拉取 7 天内的 10 个会话(每个会话包含最新一条历史消息),如需调整会话数量或时间限制请联系商务。
分页获取指定会话的历史消息
你可以调用 asyncFetchHistoryMessagesFromServer 方法从服务器获取指定会话的消息(消息漫游)。你可以指定消息查询方向,即明确按时间顺序或逆序获取。为确保数据可靠,我们建议你每次最多获取 50 条消息,可多次获取。拉取后,SDK 会自动将消息更新到本地数据库。
// 异步方法 [[EMClient sharedClient].chatManager asyncFetchHistoryMessagesFromServer:conversation.
conversationId conversationType:conversation.type startMessageId:self.moreMsgId pageSize:10 completion:
^(EMCursorResult *aResult, EMError *aError) { [self.conversation loadMessagesStartFromId:self.moreMsgId
count:10 searchDirection:EMMessageSearchDirectionUp completion:block]; }];
单向删除服务端的历史消息
你可以调用 removeMessagesFromServerWithTimeStamp 或 removeMessagesFromServerMessageIds 方法按消息时间或消息 ID 单向删除服务端的历史消息。每次最多可删除 50 条消息。消息删除后,该用户无法从服务端拉取到该消息。其他用户不受该操作影响。登录该账号的其他设备会收到 EMMultiDevicesDelegate 中的 multiDevicesMessageBeRemoved 回调,已删除的消息自动从设备本地移除。
提示
若使用该功能,需将 SDK 升级至 V3.9.8 或以上版本并联系商务开通。
示例代码如下:
// 按时间删除消息 [self.conversation removeMessagesFromServerWithTimeStamp:message.timestamp completion:
^(EMError * _Nullable aError) { }]; // 按消息 ID 删除消息 [self.conversation removeMessagesFromServe
rMessageIds:@[@"123314142214"] completion:^(EMError * _Nullable aError) { }];
删除服务端会话及其历史消息
你可以调用 deleteServerConversation 方法删除服务器端会话和历史消息。会话删除后,当前用户和其他用户均无法从服务器获取该会话。若该会话的历史消息也删除,所有用户均无法从服务器获取该会话的消息。
// 删除指定会话,如果需要保留历史消息,`isDeleteServerMessages` 参数传 `NO`,异步方法。
[[EMClient sharedClient].chatManager deleteServerConversation:@"conversationId1" conversationType
:EMConversationTypeChat isDeleteServerMessages:YES completion:^(NSString *aConversationId, EMError *aError) { // 删除回调 }];