获取历史消息
功能简介
ZIM SDK 支持按照会话维度,获取某个会话下的所有历史消息或指定消息。本文档介绍了如何使用 ZIM SDK 的接口,实现获取 单聊
历史消息、群组
历史消息和 房间
历史消息的功能。
获取全量历史消息
用户登录 ZIM SDK 后,即可通过 queryHistoryMessage 接口,传入参数 conversationID、config,获取 单聊
、群组
和 房间
的会话历史记录。
以客户端 A 获取与客户端 B 的单聊会话历史为例:
- 客户端 A、B 登录 ZIM SDK,并相互发送、接收单聊消息。
- 客户端 A 需要获取与 B 的会话记录时:
- 客户端 A 首先登录 ZIM SDK。
- 客户端 A 调用 queryHistoryMessage 接口,传入参数 conversationID、config,开始获取。
- 获取的结果,将通过 ZIMMessageQueriedResult 回调接口通知给客户端 A。
示例代码
// 1、创建 ZIM 对象,传入 AppID
ZIMAppConfig appConfig = ZIMAppConfig();
appConfig.appID = appID;
appConfig.appSign = appSign;
ZIM.create(appConfig);
// 2、登录
try{
ZIMLoginConfig loginConfig = ZIMLoginConfig();
//该用户的用户昵称,不填写代表不修改用户昵称
loginConfig.userName = 'userName';
//若使用 token 作为登录鉴权的方式,请填写该参数,否则无需填写
loginConfig.token = '';
// 本次登录是否为离线登录,详情请参考离线登录相关文档
loginConfig.isOfflineLogin = true;
await ZIM.getInstance()?.login('zego', loginConfig);
// 登录成功,编写登录成功的业务逻辑
} on PlatformException catch(onError){
// 登录失败
//登录失败的错误码,请参考接入文档的错误码表来处理
onError.code;
//登录失败的错误信息
onError.message;
}
// 3、获取单聊会话历史消息
// 从后往前获取会话历史消息,每次获取 30 条
ZIMMessageQueryConfig config = ZIMMessageQueryConfig();
// 首次获取时 nextMessage 为 null
config.nextMessage = null;
config.count = 30;
config.reverse = true;
await ZIM
.getInstance()!
.queryHistoryMessage('conversationID', ZIMConversationType.peer, config)
.then((value) => {
//成功触发此处
// 开发者可以通过该回调监听获取获取到消息列表。
// 手指往下滑动到屏幕最上方一条消息时,获取更早的消息
//保存最前的一条消息作为消息的锚点
if (fetchMore) {
// 后续分页获取时,nextMessage 为当前获取到的消息列表的第一条消息
config.nextMessage = value.messageList[0],
//递归获取
}
})
.catchError((onError) {
//失败触发此处
});
1
获取指定消息列表
ZIM 支持根据传入的 messageSeq
(消息在会话中的序号)列表(最大为 10 个),调用 queryMessages 即可查询单聊或群聊会话内对应的消息。
本接口适用于仅知道某条消息的 messageSeq
而不知道该消息的完整结构。例如,会话中有一条消息回复了某条历史消息,会话成员可以通过该条回复的 repliedInfo.messageSeq 获取该历史消息的 messageSeq
,此时即可调用本接口获取该历史消息的完整结构。
Untitled
List<int> messageSeqs = []; // 最大长度为 10
String conversationID = "YOUR_CONVERSATION_ID";
ZIMConversationType conversationType = ZIMConversationType.peer; // 会话类型,取值为 单聊:ZIMConversationTypePeer,群组:ZIMConversationTypeGroup
ZIM.getInstance()?.queryMessages(messageSeqs, conversationID, conversationType).then((value) {
// 查询成功
}).catchError((onError){
if(onError is PlatformException){
// 查询失败
}
});
1