搜索消息

本文介绍即时通讯 IM SDK 如何搜索本地消息。

技术原理

环信即时通讯 IM SDK 通过 ChatManager 和 Conversation 类支持搜索用户设备上存储的消息数据，其中包含如下主要方法：

• ChatManager#LoadMessagesWithKeyword 根据关键字搜索会话中的用户发送的消息。
• ChatManager#SearchMsgFromDB(string, long, in, string, MessageSearchDirection, MessageSearchScope, ValueCallBack<List<Message>>)：根据搜索范围搜索所有会话中的消息。
• Conversation#LoadMessagesWithScope(string, MessageSearchScope, long, int, string, MessageSearchDirection, ValueCallBack<List<Message>>)：根据搜索范围搜索当前会话中的消息。
• Conversation#LoadMessagesWithMsgTypeList ：根据单个或多个消息类型，搜索本地数据库中当前会话的消息。

前提条件

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

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

实现方法

根据关键字搜索会话中的用户发送的消息

你可以调用 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) => {
    }
));

根据消息类型搜索当前会话中的消息

你可以调用 Conversation#LoadMessagesWithMsgTypeList 方法除了设置消息时间戳、消息数量、发送方、搜索方向等条件搜索当前会话中的消息，你还可以设置单个或多个消息类型搜索本地数据库中单个会话的消息。

提示

若使用该功能，需将 SDK 升级至 V1.3.2 或以上版本。

List<MessageBodyType> tlist = new List<MessageBodyType>();
tlist.Add(MessageBodyType.TXT);
tlist.Add(MessageBodyType.IMAGE);

Conversation conv = SDKClient.Instance.ChatManager.GetConversation(conversationId, conversationType);
conv.LoadMessagesWithMsgTypeList(tlist, sender, timestamp, count, direct, new ValueCallBack<List<Message>>(
    onSuccess: (list) => {
        foreach (var it in list)
        {
        }
    },
    onError: (code, desc) => {
    }
));

关键字搜索规则

调用以下消息搜索 API 搜索不同类型的消息时，其中的 keywords 参数对应不同的内容。

• 根据关键字搜索本地数据库中单个会话中指定用户发送的消息。
• 根据关键字搜索消息时，可以选择搜索范围在所有会话中进行消息搜索。
• 根据关键字搜索消息时，可以选择搜索范围在当前会话中进行消息搜索。

只搜索消息内容

消息类型	关键字匹配的消息内容	关键字搜索内容示例
文本消息	TextBody.Text	文本消息的实际内容“你好世界”。
图片消息	ImageBody.DisplayName	图片文件名“photo.jpg”
语音消息	VoiceBody.DisplayName	语音文件名“audio.amr”
视频消息	VideoBody.DisplayName	视频文件名“video.mp4”
文件消息	FileBody.DisplayName	文件名“report.pdf”
位置消息	LocationBody.Address	地址\建筑物名称“北京市朝阳区\国贸大厦”
自定义消息	CustomBody.CustomEvent	自定义事件名“gift”
合并消息	CombineBody.Title + CombineBody.Summary	标题\摘要“聊天记录\包含5条消息”

只搜索扩展信息

若只搜索消息的扩展属性（Attributes）JSON 字符串，keywords 字段匹配用户自定义添加的扩展属性，例如：

{"key1":"value1", "key2":"value2"}

全搜索

同时搜索消息内容和扩展信息，任一匹配即返回。