搜索消息
大约 2 分钟
搜索消息
本文介绍即时通讯 IM SDK 如何搜索本地消息。
技术原理
环信即时通讯 IM SDK 通过 ChatManager
类支持搜索用户设备上存储的消息数据,其中包含如下主要方法:
ChatManager#LoadMessagesWithKeyword
根据关键字搜索会话消息。ChatManager#SearchMsgFromDB(string, long, in, string, MessageSearchDirection, MessageSearchScope, ValueCallBack<List<Message>>)
:根据搜索范围搜索所有会话中的消息。Conversation#LoadMessagesWithScope(string, MessageSearchScope, long, int, string, MessageSearchDirection, ValueCallBack<List<Message>>)
:根据搜索范围搜索当前会话中的消息。
前提条件
开始前,请确保满足以下条件:
实现方法
根据关键字搜索会话消息
你可以调用 LoadMessagesWithKeyword
方法根据关键字搜索本地数据库中单个会话中指定用户发送的消息,示例代码如下:
Conversation conv = SDKClient.Instance.ChatManager.GetConversation("convId");
conv.LoadMessagesWithKeyword(
// 搜索关键字。
"key",
// 消息发送方。
sender: "tom",
// 搜索开始的 Unix 时间戳,单位为毫秒。
timestamp: 1653971593000,
// 搜索的最大消息数。
count: 10,
// 消息的搜索方向:消息搜索方向:(默认)`UP`:按消息时间戳的逆序搜索;`DOWN`:按消息时间戳的正序搜索。
direction: MessageSearchDirection.UP,
// 回调处理
new ValueCallBack<List<Message>>(
onSuccess: (list) => {
// 遍历消息列表
foreach(var it in list)
{
}
},
onError: (code, desc) => {
}
));
根据搜索范围搜索所有会话中的消息
你可以调用 ChatManager#SearchMsgFromDB(string, long, in, string, MessageSearchDirection, MessageSearchScope, ValueCallBack<List<Message>>)
方法,除了设置关键字、消息时间戳、消息数量、发送方、搜索方向等条件搜索所有会话中的消息时,你还可以选择搜索范围,如只搜索消息内容、只搜索消息扩展信息以及同时搜索消息内容以及扩展信息。
提示
若使用该功能,需将 SDK 升级至 V1.3.0 或以上版本。
SDKClient.Instance.ChatManager.SearchMsgFromDB("keywords", -1, 10, "from", MessageSearchDirection.UP, MessageSearchScope.CONTENT, new ValueCallBack<List<Message>>(
onSuccess: (list) => {
foreach (var it in list)
{
//遍历 List<Message> 列表
}
},
onError: (code, desc) => {
}));
根据搜索范围搜索当前会话中的消息
你可以调用 Conversation#LoadMessagesWithScope(string, MessageSearchScope, long, int, string, MessageSearchDirection, ValueCallBack<List<Message>>)
方法除了设置关键字、消息时间戳、消息数量、发送方、搜索方向等条件搜索当前会话中的消息,你还可以选择搜索范围,如只搜索消息内容、只搜索消息扩展信息以及同时搜索消息内容以及扩展信息。
提示
若使用该功能,需将 SDK 升级至 V1.3.0 或以上版本。
conv.LoadMessagesWithScope("keywords", MessageSearchScope.CONTENT, -1, 10, "from", MessageSearchDirection.UP, new ValueCallBack<List<Message>>(
onSuccess: (list) => {
foreach (var it in list)
{
//遍历 List<Message> 列表
}
},
onError: (code, desc) => {
}
));