搜索本地消息
SDK 从 5.3.4 版本开始支持超级群本地消息搜索功能。
SDK 允许 App 通过关键词、用户 ID 等条件搜索指定超级群频道或多个频道中已拉取到本地的消息，支持按时间段搜索。
并非所有消息类型均支持关键字搜索：
- 内置的消息类型中 文本消息（RCTextMessage)，文件消息（RCFileMessage），和图文消息
RCRichContentMessage类型默认实现了RCMessageCoding协议的getSearchableWords方法。 - 自定义消息类型也可以支持关键字搜索，需要您参考文档自行实现。详见自定义消息类型。
请注意，消息搜索仅查询本地数据库。超级群默认每次连接时只同步频道最后一条消息，因此超级群业务本地消息记录可能不完整，需要 App 自行将消息拉取到本地（一般在进入会话页面时主动获取历史消息）。
融云提供搜索超级群历史消息记录的 IM Server API。详见服务端文档搜索超级群消息。
搜索会话
按关键字搜索本地所有会话。返回符合条件的搜索结果（RCSearchConversationResult）列表。请注意，超级群业务中单个会话（conversation）仅对应单个超级群频道。
NSArray *conversationTypeList = @[@(ConversationType_ULTRAGROUP)];
NSArray *objectNameList = @[@"RC:TXT"];
[[RCChannelClient sharedChannelManager] searchConversations:conversationTypeList
messageType:objectNameList
keyword:@"搜索的关键字"
completion:^(NSArray<RCSearchConversationResult *> * _Nullable results) {
//异步回调
}];
如果搜索条件与搜索结果包含多个会话类型，您可以通过返回结果中 RCConversation 对象的会话类型（conversationType）字段进行分类或筛选。
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationTypeList | NSArray | 会话类型列表，包含 RCConversationType。例如 ConversationType_PRIVATE，ConversationType_GROUP，ConversationType_ULTRAGROUP。 |
| objectNameList | NSArray | 消息类型列表，默认仅支持内置类型 RC:TxtMsg（文本消息）、RC:FileMsg（文件消息）、RC:ImgTextMsg（图文消息 ）。 |
| keyword | NSString | 关键字。不可为空。 |
| completion | Block | 异步回调。results 中返回 RCSearchConversationResult 列表。请注意，超级群业务中单个会话（conversation）仅对应单个超级群频道。 |
搜索单个频道的消息
获取包含关键词的会话列表后，可以搜索指定单个会话中符合条件的消息。在实现超级群消息搜索时，App 可以先通过搜索会话获取符合条件的超级群会话列表，再搜索指定频道中符合条件的消息。
搜索单个频道 的消息需要 App 同时提供超级群 ID（targetId） 与 频道 ID（channelId）。
根据关键字搜索指定频道的消息
在本地存储中根据关键字搜索指定频道会话中的消息，支持搜索指定时间点之前的历史消息记录。回调中分页返回包含指定关键字的消息列表。
[[RCChannelClient sharedChannelManager] searchMessages:ConversationType_ULTRAGROUP
targetId:@"超级群 ID"
channelId:@"超级群频道 ID"
keyword:searchText
count:50
startTime:0
completion:^(NSArray<RCMessage *> * _Nullable messages) {
//异步回调
}];
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationType | RCConversationType | 会话类型。超级群会话传入 ConversationType_ULTRAGROUP。 |
| targetId | NSString | 超级群 ID。 |
| channelId | NSString | 超级群频道 ID。 |
| keyword | NSString | 关键字。传空默认为是查全部符合条件的消息。 |
| count | int | 最大的查询数量 |
| startTime | long long | 询记录的起始时间。传 0 时从最新消息开始搜索。非 0 时从该时间往前搜索。 |
| completion | Block | 异步回调。messages 中返回匹配的 RCMessage 列表。 |
根据关键字搜索指定时间段内指定频道的消息
SDK 支持将关键字搜索的范围限制在指定时间段内。回调中分页返回包含指定关键字和时间段要求的消息列表。
[[RCChannelClient sharedChannelManager] searchMessages:ConversationType_ULTRAGROUP
targetId:@"超级群 ID"
channelId:@"超级群频道 ID"
keyword:searchText
startTime:startTime
endTime:endTime
offset:0
limit:100
completion:^(NSArray<RCMessage *> * _Nullable messages) {
//异步回调
}];
limit 参数控制返回的搜索结果数量，取值范围为 [1-100]。超过 100 默认使用最大值 100。
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationType | RCConversationType | 会话类型。超级群会话传入 ConversationType_ULTRAGROUP。 |
| targetId | NSString | 超级群 ID。 |
| channelId | NSString | 超级群频道 ID。 |
| keyword | NSString | 关键字。传空默认为是查全部符合条件的消息。 |
| startTime | long long | 查询记录的起始时间。传 0 时从最新消息开始搜索。非 0 时从该时间往前搜索。 |
| endTime | long long | 结束时间 |
| offset | int | 偏移量。要求 ≧ 0。 |
| limit | int | 返回的搜索结果数量，limit 需大于 0。最大值为 100。超过 100 时默认返回 100 条。 |
| completion | Block | 异步回调。messages 中返回匹配的 RCMessage 列表。 |
根据用户 ID 搜索指定频道的消息
在本地存储中根据搜索来自指定用户 ID 的消息，支持搜索指定时间点之前的历史消息记录。回调中分页返回包含符合条件的消息列表。
[[RCChannelClient sharedChannelManager] searchMessages:ConversationType_ULTRAGROUP
targetId:@"接收方 id"
channelId:@"超级群频道 ID"
userId:@"userId"
count:50
startTime:0
completion:^(NSArray<RCMessage *> * _Nullable messages) {
//异步回调
}];
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationType | RCConversationType | 会话类型。超级群会话传入 ConversationType_ULTRAGROUP。 |
| targetId | NSString | 超级群 ID。 |
| channelId | NSString | 超级群频道 ID。 |
| userId | NSString | 搜索用户 ID。 |
| count | int | 最大的查询数量 |
| startTime | long long | 查询记录的起始时间。传 0 时从最新消息开始搜索。非 0 时从该时间往前搜索。 |
| completion | Block | 异步回调。messages 中返回匹配的 RCMessage 列表。 |
搜索多个频道的消息
App 如需搜索指定超级群的消息，并已持有超级群 ID（targetId），可以直接使用以下接口搜索本地已接收、已存储的消息。符合搜索条件的消息可能来自多个频道。
根据关键字搜索指定超级群本地所有频道的消息
搜索指定超级群存储在本地的消息，支持搜索指定时间点之前的历史消息记录。回调中分页返回包含指定关键字的消息列表。
[[RCChannelClient sharedChannelManager] searchMessagesForAllChannel:ConversationType_ULTRAGROUP
targetId:@"超级群 ID"
keyword:searchText
count:50
startTime:0
completion:^(NSArray<RCMessage *> * _Nullable messages) {
//异步回调
}];
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationType | RCConversationType | 会话类型。超级群会话传入 ConversationType_ULTRAGROUP。 |
| targetId | NSString | 超级群 ID。 |
| keyword | NSString | 关键字。传空默认为是查全部符合条件的消息。 |
| count | int | 最大的查询数量 |
| startTime | long long | 询记录的起始时间。传 0 时从最新消息开始搜索。非 0 时从该时间往前搜索。 |
| completion | Block | 异步回调。messages 中返回匹配的 RCMessage 列表。 |
根据关键字搜索指定超级群指定时间段内本地所有频道的消息
在通过关键字搜索指定超级群存储在本地的消息时，SDK 支持将搜索范围限制在指定时间段内。回调中分页返回包含指定关键字和时间段要求的消息列表。
[[RCChannelClient sharedChannelManager] searchMessagesForAllChannel:ConversationType_ULTRAGROUP
targetId:@"超级群 ID"
keyword:searchText
startTime:startTime
endTime:endTime
offset:0
limit:100
completion:^(NSArray<RCMessage *> * _Nullable messages) {
//异步回调
}];
limit 参数控制返回的搜索结果数量，取值范围为 [1-100]。超过 100 默认使用最大值 100。
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationType | RCConversationType | 会话类型。超级群会话传入 ConversationType_ULTRAGROUP。 |
| targetId | NSString | 超级群 ID。 |
| keyword | NSString | 关键字。传空默认为是查全部符合条件的消息。 |
| startTime | long long | 查询记录的起始时间。传 0 时从最新消息开始搜索。非 0 时从该时间往前搜索。 |
| endTime | long long | 结束时间 |
| offset | int | 偏移量。要求 ≧ 0。 |
| limit | int | 返回的搜索结果数量，limit 需大于 0。最大值为 100。超过 100 时默认返回 100 条。 |
| completion | Block | 异步回调。messages 中返回匹配的 RCMessage 列表。 |
根据关键字搜索指定超级群下多个频道的本地历史消息
SDK 从 5.6.2 版本开始提供该方法。
请确保传入合法的 Channel ID 数组。Channel ID 数组不可为空，ID 数量不可超过 50 个，数组中的 Channel ID 均必须为合法有效的值（大小写英文字母与数字），不支持 Channel ID 为空字符串。支持从最新消息开始搜索，或者搜索早于 startTime 的消息。每次搜索最大 100 条，如果还有更多的消息，可以将 startTime 设为获取到的消息数组最后一条消息的时间戳，然后继续调用接口。
/// 根据关键字搜索指定超级群下多个频道的本地历史消息
///
/// - Parameter conversationType: 会话类型
/// - Parameter targetId: 会话 id
/// - Parameter channelIds: 频道列表，支持一次查询多个频道，不能超过 50 个
/// - Parameter keyword: 查询内容关键字
/// - Parameter startTime: 查询 startTime 之前的消息（传 0 表示从最新消息开始搜索）
/// - Parameter limit: 最大的查询数量，limit 需大于 0，最大值为 100，如果大于 100，会默认成 100。
/// - Parameter successBlock: [messages] 满足条件的消息列表，按时间倒序排序
/// - Parameter errorBlock: [errorCode] 错误码
///
/// - Since: 5.6.2
- (void)searchMessagesForChannels:(RCConversationType)conversationType
targetId:(NSString *)targetId
channelIds:(NSArray<NSString *> *)channelIds
keyword:(NSString *)keyword
startTime:(long long)startTime
limit:(int)limit
success:(void (^)(NSArray<RCMessage *> *messages))successBlock
error:(nullable void (^)(RCErrorCode errorCode))errorBlock;
根据发送者用户 ID 搜索指定超级群下多个频道的本地历史消息
SDK 从 5.6.2 版本开始提供该方法。
请确保传入合法的 Channel ID 数组。Channel ID 数组不可为空，ID 数量不可超过 50 个，数组中的 Channel ID 均必须为合法有效的值（大小写英文字母与数字），不支持 Channel ID 为空字符串。支持从最新消息开始搜索，或者搜索早于 startTime 的消息。每次搜索最大 100 条，如果还有更多的消息，可以将 startTime 设为获取到的消息数组最后一条消息的时间戳，然后继续调用接口。
/// 根据发送者用户 ID 搜索指定超级群下多个频道的本地历史消息
///
/// - Parameter conversationType: 会话类型
/// - Parameter targetId: 会话 id
/// - Parameter channelIds: 频道列表，支持一次查询多个频道，不能超过 50 个
/// - Parameter userId: 消息发送者用户 ID
/// - Parameter startTime: 查询 startTime 之前的消息（传 0 表示从最新消息开始搜索）
/// - Parameter limit: 最大的查询数量，limit 需大于 0，最大值为 100，如果大于 100，会默认成 100。
/// - Parameter successBlock: [messages] 满足条件的消息列表，按时间倒序排序
/// - Parameter errorBlock: [errorCode] 错误码
///
/// - Since: 5.6.2
- (void)searchMessagesByUserForChannels:(RCConversationType)conversationType
targetId:(NSString *)targetId
channelIds:(NSArray<NSString *> *)channelIds
userId:(NSString *)userId
startTime:(long long)startTime
limit:(int)limit
success:(void (^)(NSArray<RCMessage *> *messages))successBlock
error:(nullable void (^)(RCErrorCode errorCode))errorBlock;
根据发送者用户 ID 搜索指定超级群下所有频道的本地历史消息
SDK 从 5.6.2 版本开始提供该方法。
支持从最新消息开始搜索，或者搜索早于 startTime 的消息。每次搜索最大 100 条，如果还有更多的消息，可以将 startTime 设为获取到的消息数组最后一条消息的时间戳，然后继续调用接口。
/// 根据发送者用户 ID 搜索指定超级群下所有频道的本地历史消息
///
/// - Parameter conversationType: 会话类型
/// - Parameter targetId: 会话 id
/// - Parameter userId: 消息发送者用户 ID
/// - Parameter startTime: 查询 startTime 之前的消息（传 0 表示从最新消息开始搜索）
/// - Parameter limit: 最大的查询数量，limit 需大于 0，最大值为 100，如果大于 100，会默认成 100。
/// - Parameter successBlock: [messages] 满足条件的消息列表，按时间倒序排序
/// - Parameter errorBlock: [errorCode] 错误码
///
/// - Since: 5.6.2
- (void)searchMessagesByUserForAllChannel:(RCConversationType)conversationType
targetId:(NSString *)targetId
userId:(NSString *)userId
startTime:(long long)startTime
limit:(int)limit
success:(void (^)(NSArray<RCMessage *> *messages))successBlock
error:(nullable void (^)(RCErrorCode errorCode))errorBlock;