搜索本地消息

功能简介

凭借 ZIM SDK，您可以通过关键字、用户 ID 等条件对单个或所有 单聊 和 群聊 会话的本地消息进行搜索，获取符合条件的消息列表；也可以基于本地消息搜索会话。

搜索指定会话的本地消息

创建 ZIM 对象并登录后，调用 searchLocalMessagesByConversationID 接口，传入参数 conversationID、conversationType、config，设置搜索条件（如关键词），获取某个会话中符合条件的本地消息。

符合条件的消息列表，将通过 ZIMMessagesSearchedCallback 回调接口返回并。

示例代码

// 搜索单个会话 7 天内的包含 "zego" 的本地文本消息。
NSDate *currentDate = [NSDate date];
NSTimeInterval currentTimestamp = [currentDate timeIntervalSince1970];

long long startTimestamp = currentTimestamp - (7 * 24 * 60 * 60 * 1000);

NSString *conversationID = @"xxxx"; // 会话 ID
                                    // 单聊会话的 conversationID 为对方的 userID。
                                    // 群组会话的 conversationID 为群组的 groupID。

ZIMMessageSearchConfig *config =  [[ZIMMessageSearchConfig alloc] init];
config.count = 20;  // 搜索结果数量
config.order = ZIMMessageOrderDescending;  // 指定搜索顺序为从本地存储的最后（时间）一条消息向前查询
config.keywords = @[@"zego"];  // 设置关键词为 “zego”，最多支持 5 个。当设置多个关键词后，搜索结果只展示同时包含所有关键词的本地消息
config.messageTypes = @[[NSNumber numberWithInt:ZIMMessageTypeText]]; // 指定消息类型为文本
config.startTime = startTimestamp; // 搜索的起始时间点
config.endTime = currentTimestamp; // 搜索的结束时间点


[[ZIM getInstance] searchLocalMessagesByConversationID:conversationID conversationType:ZIMConversationTypePeer config:config callback:^(NSString * _Nonnull conversationID, ZIMConversationType conversationType, NSArray<ZIMMessage *> * _Nonnull messageList, ZIMMessage * _Nullable nextMessage, ZIMError * _Nonnull errorInfo) {
    // 开发者可以通过该回调监听获取搜索到消息列表。
}];

Copied!

搜索全局本地消息

搜索结果按会话分类

创建 ZIM 对象并登录后，调用 searchGlobalLocalMessagesWithConfig 接口，传入参数 config，设置搜索条件（如关键词），全局搜索符合条件的本地消息。

符合条件的消息列表，将通过 ZIMMessagesGlobalSearchedCallback 回调接口返回并按会话分类。

示例代码

// 全局搜索 7 天内的包含 "zego" 的本地文本消息。

NSDate *currentDate = [NSDate date];
NSTimeInterval currentTimestamp = [currentDate timeIntervalSince1970];

long long startTimestamp = currentTimestamp - (7 * 24 * 60 * 60 * 1000);

ZIMMessageSearchConfig *config = [[ZIMMessageSearchConfig alloc] init];
config.count = 20;  // 搜索结果数量
config.order = ZIMMessageOrderDescending;  // 指定搜索顺序为从本地存储的最后（时间）一条消息向前查询
config.keywords = @[@"zego"];  // 设置关键词为 “zego”，最多支持 5 个。当设置多个关键词后，搜索结果只展示同时包含所有关键词的本地消息
config.messageTypes = @[[NSNumber numberWithInt:ZIMMessageTypeText]]; // 指定消息类型为文本
config.startTime = startTimestamp; // 搜索的开始时间点
config.endTime = currentTimestamp; // 搜索的结束时间点
[[ZIM getInstance] searchGlobalLocalMessagesWithConfig:config callback:^(NSArray<ZIMMessage *> * _Nonnull messageList, ZIMMessage * _Nullable nextMessage, ZIMError * _Nonnull errorInfo) {
    // 开发者可以通过该回调监听获取搜索到消息列表。
}];

Copied!

基于本地消息搜索会话

创建 ZIM 对象并登录后，调用 searchLocalConversationsWithConfig 接口，传入参数 config，设置与本地消息相关的搜索条件，全局搜索符合条件的会话。

符合条件的会话列表，将通过 ZIMConversationsSearchedCallback 回调接口返回。

示例代码

// 搜索 7 天内包含关键字 "zego" 的本地文本消息，以此获取对应的会话列表

NSDate *currentDate = [NSDate date];
NSTimeInterval currentTimestamp = [currentDate timeIntervalSince1970];

long long startTimestamp = currentTimestamp - (7 * 24 * 60 * 60 * 1000);
ZIMConversationSearchConfig *config = [[ZIMConversationSearchConfig alloc] init];
config.totalConversationCount = 10;
config.conversationMessageCount = 3;
config.nextFlag = 0;
config.keywords = @[@"zego"];  // 设置关键词为 “zego”，最多支持 5
config.messageTypes = @[[NSNumber numberWithInt:ZIMMessageTypeText]]; // 指定消息类型为文本
config.startTime = startTimestamp;
config.endTime = currentTimestamp;

[[ZIM getInstance] searchLocalConversationsWithConfig:config callback:^(NSArray<ZIMConversationSearchInfo *> * _Nonnull conversationSearchInfoList, unsigned int nextFlag, ZIMError * _Nonnull errorInfo) {
    // 开发者可以通过该回调监听获取搜索到的会话信息
}];

Copied!