网易云信即时通讯 NIM SDK 的NIMQChatServerManager协议提供搜索圈组的服务器和服务器成员方法，NIMQChatChannelManager协议提供搜索频道和频道成员的方法。

SDK 还支持配置搜索结果的排序规则，如搜索出的服务器列表可按时间和人数等维度排序，也可自定义排序。

应用场景

圈组的搜索能力和配套的搜索结果排序能力，可满足您的应用的特定运营需求，如：

• 通过按人数排序，将热门社区（对应圈组服务器）展示在用户搜索结果的前列，方便用户加入热门社区。
• 通过自定义排序，将广告位性质的话题（对应频道）展示在用户搜索结果的前列，增加流量引入。

技术原理

搜索数据来源

下图左侧所示事件发生后，将触发相关消息通过消息队列（Message Queue）通知云信搜索服务器，搜索服务器把相关的事件数据保存或更新至 Elasticsearch。

由于整个数据传送过程都是通过消息队列生产消费，且 Elasticsearch 的数据每秒刷新一次，所以整体的搜索数据存在一定的延迟（正常 3 秒内）。

与服务器的关联逻辑

服务器创建、更新、查询等方法（包括createServer和updateServer），入参包含searchEnable和searchType。

参数	说明
searchEnable	服务器是否允许被搜索，true-允许，false-不允许，默认允许
searchType	服务器搜索类型，客户自定义，大于等于 0 的整数。 0 代表无类型

前提条件

在开始圈组搜索功能集成前，请确保您已：

• 已开通圈组搜索功能。圈组搜索功能需要在开通圈组功能的基础上额外开通后才能使用。
• 已创建圈组服务器。
• 已创建频道。

实现原理

搜索服务器

调用searchServerByPage方法可搜索服务器，返回在startTime和endTime之间的时间段内创建并与keyword匹配的服务器。

该方法的入参如下表所示：

参数	必传	类型	说明
keyword	是	NSString	目标检索服务器名称的关键字，最大长度 100 字符，支持模糊搜索。关键字必须为连续字符串，? 和 * 会被忽略。 例子：假设服务器的名称为“网易云信专属服务器”，用户使用如下三个关键字进行搜索，keyword1=“网易云信”，keyword2=“专属服”，keyword3=“网专属”,keyword4=“网易 云信”，那么只有 keyword1 和 keyword2 能搜索到该服务器
asc	是	BOOL	true-升序，false-降序
searchType	是	NIMQChatSearchServerType	配置搜索类型： 传 NIMQChatSearchServerTypeSquare 为在广场搜索服务器，即全局搜索服务器 传 NIMQChatSearchServerTypePersonal 为搜索已加入的服务器
startTime	否	NSNumber	查询时间范围的开始时间
endTime	否	NSNumber	查询时间范围的结束时间，必须比开始时间晚
limit	否	NSNumber	每页数据条数，最大和默认都是 100
serverTypes	否	NSArray<NSNumber *>	服务器类型，对应创建服务器时传入的searchType
sortType	否	NIMQChatSearchServerSortType	服务器的排序条件，默认为按创建时间倒序排序，即最新创建的服务器排在最前 如需实现搜索结果自定义排序，请参照下文的搜索结果自定义排序中的说明进行配置
cursor	否	NSString	查询游标，查询的起始位置，上一次查询会返回cursor字段

全局搜索服务器

全局搜索集成圈组的应用内的所有服务器，包括已加入的和未加入的服务器。

全局搜索仅能搜索到“允许被搜索”的服务器。

• 示例代码

  NIMQChatSearchServerByPageParam *param = [[NIMQChatSearchServerByPageParam alloc] init];
  param.keyword = @"keyword";
  param.asc = YES;
  param.searchType = NIMQChatSearchServerTypeSquare;
  [NIMSDK.sharedSDK.qchatServerManager searchServerByPage:param completion:^(NSError * _Nullable error, NIMQChatSearchServerByPageResult *_Nullable result) {
      //检索完成
  }];
  

搜索已加入的服务器

• 示例代码

  NIMQChatSearchServerByPageParam *param = [[NIMQChatSearchServerByPageParam alloc] init];
  param.keyword = @"keyword";
  param.asc = YES;
  param.searchType = NIMQChatSearchServerTypePersonal;
  [NIMSDK.sharedSDK.qchatServerManager searchServerByPage:param completion:^(NSError * _Nullable error, NIMQChatSearchServerByPageResult *_Nullable result) {
      //检索完成
  }];
  

搜索服务器成员

调用searchServerMemberByPage方法搜索服务器成员。

参数	必传	类型	说明
keyword	是	NSString	目标成员的昵称或 IM 账号的关键字，最大 100 个字符，支持模糊搜索，模糊搜索的限制同上文提及的搜索服务器的 keyword
serverId	是	unsinged long long	服务器 ID
limit	否	NSNumber	每页数据条数，最大和默认都是 100

示例代码

NIMQChatSearchServerMemberByPageParam *param = [[NIMQChatSearchServerMemberByPageParam alloc] init];
param.keyword = @"keyword";
param.serverId = 123456;
[NIMSDK.sharedSDK.qchatServerManager searchServerMemberByPage:param completion:^(NSError * _Nullable error, NIMQChatSearchServerMemberByPageResult *_Nullable result) {
    //检索完成
}];

搜索频道

调用searchChannelByPage方法搜索对自己可见的频道（即自己未被加入黑名单的公开频道和已被加入白名单的私密频道）。

入参	必传	类型	说明
keyword	是	NSString	目标检索频道名称的关键字，支持模糊搜索，模糊搜索的限制同上文提及的搜索服务器的 keyword
asc	是	BOOL	排序规则 ASC-升序，DESC-降序
startTime	否	NSNumber	查询时间范围的开始时间，单位s
endTime	否	NSNumber	查询时间范围的结束时间，要求比开始时间大，单位s
limit	否	NSNumber	每页数据条数，最大和默认都是 100
serverId	否	unsinged long long	服务器ID，填0表示不限制在某个服务器内查询
sortType	否	NIMQChatSearchChannelSortType	服务器的排序条件，默认为按创建时间倒序排序，即最新创建的服务器排在最前 如需实现搜索结果自定义排序，请参照下文的搜索结果自定义排序中的说明进行配置
cursor	否	NSString	查询游标，查询的起始位置，上一次查询会返回cursor字段

示例代码

NIMQChatSearchChannelByPageParam *param = [[NIMQChatSearchChannelByPageParam alloc] init];
param.keyword = @"keyword";
param.asc = YES;
param.serverId = 123456;
[NIMSDK.sharedSDK.qchatChannelManager searchChannelByPage:param completion:^(NSError * _Nullable error, NIMQChatSearchChannelByPageResult *_Nullable result) {
    //检索完成
}];

搜索频道成员

调用searchServerChannelMember方法搜索频道成员。

参数	必传	类型	说明
keyword	是	NSString	目标成员的昵称或 IM 账号的关键字，最大 100 个字符，支持模糊搜索，模糊搜索的限制同上文提及的搜索服务器的 keyword
serverId	是	unsinged long long	服务器 ID
channelId	是	unsinged long long	频道 ID
limit	否	NSNumber	检索返回的最大记录数，最大和默认都是 100

示例代码

NIMQChatSearchServerChannelMemberParam *param = [NIMQChatSearchServerChannelMemberParam new];
param.keyword = @"";
param.serverId = 123456;
param.channelId = 123456;
param.limit = @(100);
    
[[[NIMSDK.sharedSDK.qchatServerManager searchServerChannelMember:param completion:^(NSError * _Nullable error,    NIMQChatSearchServerChannelMemberResult * _Nullable result) {
       // 回调内容
}];

搜索结果自定义排序

• 创建服务器成功后返回的NIMQChatServer包含服务器的自定义排序权重信息 reorderWeight（NIMQChatSearchServerSortTypeCustomWeight），默认为 0。
• 创建频道成功后返回的NIMQChatChannel包含频道的自定义排序权重信息 reorderWeight（NIMQChatSearchChannelSortTypeCustomWeight），默认为 0。自定义排序权重值，目前仅支持通过服务器端 API 修改。
• 创建频道分组成功后返回的NIMQChatChannelCategory包含频道的自定义排序权重信息 reorderWeight，默认为 0。自定义排序权重值，目前仅支持通过服务器端 API 修改。

服务器自定义排序

实现服务器搜索结果自定义排序的流程如下：

1. 调用服务端 API （qchat/batchUpdateServerReorderWeight.action）修改服务器的自定义排序权重默认值。

   调用该 API 单次可修改权重的服务器的数量上限默认为 10。如需调整该上限，请通过云信官网首页的在线聊天、微信和电话等联系方式咨询商务经理。

2. 调用searchServerByPage方法搜索服务器。调用时除了必传的入参keyword、searchType和asc外，还需传入sortType，且将其设置为NIMQChatSearchServerSortTypeCustomWeight。

   结果：

   • 如asc为默认倒序，则匹配的服务器列表以权重值倒序排列，相同权重的服务器按serverId倒序排列。
   • 如asc为正序，则按权重值正序排序，相同权重的按serverId倒序排列。

频道自定义排序

实现频道搜索结果自定义排序的流程如下：

1. 调用服务端 API （qchat/batchUpdateChannelReorderWeight.action ）修改频道的自定义排序权重默认值。

   调用该 API 单次可修改权重值的频道的数量上限默认为 10。如需调整该上限，请通过云信官网首页的在线聊天、微信和电话等联系方式咨询商务经理。

2. 调用searchChannelByPage方法搜索频道。调用时除了必传的入参keyword 和asc外，还需传入sortType，且将其设置为NIMQChatSearchChannelSortTypeCustomWeight。

   结果：

   • 如asc为默认倒序，则匹配的频道列表以权重值倒序排列，相同权重的频道按channelId倒序排列。
   • 如asc为正序，则按权重值正序排序，相同权重的按channelId倒序排列。

频道分组自定义排序

实现频道分组搜索结果自定义排序的流程如下：

1. 调用服务端 API（qchat/updateChannelCategory.action）修改频道分组的自定义排序权重默认值。

2. 调用 getCategoriesInServerByPage 方法查询频道分组。调用时将入参 sortType 设置为 按自定义权重排序，并传入 cursor 实现分页。

   示例代码如下：

   objcid<NIMQChatChannelManager> qchatChannelManager = [[NIMSDK sharedSDK] qchatChannelManager];
   NIMQChatGetCategoriesInServerByPageParam * param = [[NIMQChatGetCategoriesInServerByPageParam alloc] init];
   param.serverId = 123456;
   param.limit = @(20);
   // 返回值的排序类型
   // 配置为NIMQChatSearchChannelSortTypeCustomWeight时，使用cursor分页
   // 配置为NIMQChatSearchChannelSortTypeCreateTime时，使用timeTag分页
   param.sortType = NIMQChatSearchChannelSortTypeCustomWeight;
   // 这里配置为NIMQChatSearchChannelSortTypeCustomWeight，用cursor分页
   param.cursor = @"1234567890123";
   // 这里配置为NIMQChatSearchChannelSortTypeCustomWeight，不填时间
   // param.timeTag = 1234567890.123;
   
   [qchatChannelManager getCategoriesInServerByPage:param
       completion:^(NSError *__nullable error, NIMQChatGetCategoriesInServerByPageResult *__nullable result) {
       // your code
   }];