跳到主要内容

搜索消息

SDK 提供了本地消息搜索功能，允许 App 用户通过关键词、用户 ID 等条件搜索指定的单个会话中的消息，支持按时间段搜索。消息搜索仅查询本地数据库中的消息，返回包含指定关键字或符合全部搜索条件的消息列表。

并非所有消息类型均支持关键字搜索：

  • 内置的消息类型中文本消息（TextMessage)，文件消息（FileMessage），和图文消息RichContentMessage 类型默认实现了 MessageContent#getSearchableWord 方法。
  • 自定义消息类型也可以支持关键字搜索，需要您参考文档自行实现。详见自定义消息类型。

如何实现基于关键字的全局搜索：

  1. 根据关键字搜索本地存储的全部会话，获取包含关键字的会话列表。
  2. 根据搜索会话返回的会话列表数据，调用搜索单个会话的方法，搜索符合条件的消息。

搜索全部会话​

按关键字搜索本地存储的所有会话，获取符合条件的会话列表 SearchConversationResult。

String keyword = "搜索的关键字";

Conversation.ConversationTypes[] conversationTypes = {ConversationTypes.PRIVATE, ConversationTypes.GROUP};
String[] messageTypeObjectNames = {"RC:TxtMsg"};

RongIMClient.getInstance().searchConversations(keyword, conversationTypes, messageTypeObjectNames,
    new RongIMClient.ResultCallback<List<SearchConversationResult>>() {

    @Override
    public void onSuccess(List<SearchConversationResult> searchConversationResults) {

    }

    @Override
    public void onError(RongIMClient.ErrorCode errorCode) {

    }
});
参数类型说明
keywordString搜索的关键字
conversationTypesConversation.ConversationType[]会话类型列表，包含 ConversationType。
objectNamesString[]消息类型列表，默认仅支持内置类型 RC:TxtMsg（文本消息）、RC:FileMsg（文件消息）、RC:ImgTextMsg（图文消息 ）。
callbackRongIMClient.ResultCallback<List<SearchConversationResult>>回调。搜索结果为 SearchConversationResult 列表。

在指定单个会话中搜索​

获取包含关键词的会话列表后，可以搜索指定单个会话中符合条件的消息。

根据关键字搜索消息​

在本地存储中根据关键字搜索指定会话中的消息，支持搜索指定时间点之前的历史消息记录。回调中分页返回包含指定关键字的消息列表。

ConversationType conversationType = ConversationType.PRIVATE;
String targetId = " 会话 Id ";
String keyword = "搜索的关键字";
int count = 20;
long beginTime = 122323344;

RongIMClient.getInstance().searchMessages(conversationType, targetId, keyword, count, beginTime,
    new RongIMClient.ResultCallback<List<Message>>() {

    @Override
    public void onSuccess(List<Message> messages) {

    }

    @Override
    public void onError(RongIMClient.ErrorCode errorCode) {

    }
});
参数类型说明
conversationTypeConversationType会话类型。
targetIdString会话 ID。
keywordString搜索的关键字。
countint每页的数量，每页数量建议最多 100 条。传 0 时返回所有搜索到的消息。
beginTimelong查询记录的起始时间。传 0 时从最新消息开始搜索。非 0 时从该时间往前搜索。
callbackRongIMClient.ResultCallback<List<Message>>回调。搜索结果为 Message 列表。

根据关键字搜索指定时间段的消息​

提示

RongIMClient 中不提供该方法。请使用 RongCoreClient。

SDK 支持将关键字搜索的范围限制在指定时间段内。回调中分页返回包含指定关键字和时间段要求的消息列表。

ConversationType conversationType = ConversationType.PRIVATE;
String targetId = " 会话 Id ";
String keyword = "123";
long startTime = 0;
long endTime = 1585815113;
int offset = 0;
int limit = 80;

RongCoreClient.getInstance().searchMessages(conversationType, targetId, keyword, startTime, endTime, offset, limit,
    new IRongCoreCallback.ResultCallback<List<Message>>(){

    @Override
    public void onSuccess(List<Messag> messages) {

    }

    @Override
     public void onError(IRongCoreEnum.CoreErrorCode e) {

    }
});

limit 参数控制返回的搜索结果数量，取值范围为 [1-100]。超过 100 默认使用最大值 100。

参数类型说明
conversationTypeConversationType会话类型
targetIdString会话 Id
keywordString搜索的关键字
startTimelong开始时间
endTimelong结束时间
offsetint偏移量
limitint返回的搜索结果数量，limit 需大于 0。最大值为 100。超过 100 时默认返回 100 条。
callbackIRongCallback.ResultCallback<List<Message>>回调。搜索结果为 Message 列表。

根据用户 ID 搜索消息​

在本地存储中根据搜索来自指定用户 ID 的消息，支持搜索指定时间点之前的历史消息记录。回调中分页返回包含符合条件的消息列表。

ConversationType conversationType = ConversationType.PRIVATE;
String targetId = " 会话 Id ";
String userId = "查询的用户 Id";
int count = 20;
long beginTime = 1585815113;

RongIMClient.getInstance().searchMessagesByUser(conversationType, targetId, userId, count, beginTime,
    new RongIMClient.ResultCallback<Message>() {

    @Override
    public void onSuccess(List<Messag> messages) {

    }

    @Override
    public void onError(RongIMClient.ErrorCode errorCode) {

    }
});
参数类型说明
conversationTypeConversationType会话类型
targetIdString会话 ID。
userIdString要查询的用户 ID。
countint返回的搜索结果数量。最大值为 100。超过 100 时默认返回 100 条。
beginTimelong查询记录的起始时间。传 0 时从最新消息开始搜索。非 0 时从该时间往前搜索。
callbackIRongCallback.ResultCallback<List<Message>>回调。搜索结果为 Message 列表。
最后于 更新