NIM SDK 的NIMQChatServerManager类提供了管理服务器成员的方法，包括加入服务器、离开服务器、将成员踢出服务器和封禁成员等。

服务器成员定义

SDK 的NIMQChatServerMember类定义了服务器成员。该类的成员参数如下：

前提条件

• 已注册onRecvSystemNotification:监听圈组的系统通知。示例代码参见圈组系统通知收发。

  具体与服务器成员管理相关的系统通知类型，见本文末尾的相关系统通知。

• 已创建服务器。

使用限制

服务器存在如下与其成员数量相关的限制：

• 单个用户的服务器的数量上限（包括自己创建的和加入的）默认为 100 个。
• 单个服务器可容人数上限默认为 500000。

若需要扩展上限，可在控制台配置圈组子功能项（单个用户 server 数 和 单 server 容纳人数），具体请参考开通和配置圈组功能。

实现方法

加入服务器

邀请用户加入

拥有“邀请他人加入服务器的权限”（NIMQChatPermissionType枚举中的NIMQChatPermissionTypeInviteServer）的用户，可邀请其他用户加入服务器。

根据服务器的不同邀请模式（NIMQChatServerInviteMode），被邀者成功加入服务器的流程略有不同。服务器的邀请模式，在创建服务器时配置，创建后也可修改。

sequenceDiagram



note over NIM SDK: 初始化 SDK 并登录 IM
note over NIM SDK: 注册监听并登录圈组
邀请方 ->> NIM SDK: 监听圈组系统通知
"用户A(被邀方)" ->> NIM SDK: 监听圈组系统通知
邀请方 ->> NIM SDK: 登录圈组
"用户A(被邀方)" ->> NIM SDK: 登录圈组
note over NIM SDK: 发起邀请
note left of 邀请方: 必须拥有"邀请他人加入服务器"的权限
邀请方 ->> NIM SDK: 邀请用户A加入服务器
NIM SDK ->> "用户A(被邀方)": 圈组系统通知
note over "用户A(被邀方)": 从系统通知获取requestId、serverId和邀请者的accid
note over NIM SDK: 接受邀请
"用户A(被邀方)" ->> NIM SDK: 接受邀请
note over "用户A(被邀方)": 接受邀请时需传入requestId、serverId和邀请者的accid
NIM SDK ->> 邀请方: 邀请被接受 & 用户A加入服务器的系统通知
NIM SDK ->> "用户A(被邀方)": 用户A加入服务器的系统通知

申请加入

用户也可以主动申请加入某个服务器。根据服务器的不同申请模式，申请方成功加入服务器的流程略有不同。

sequenceDiagram



note over NIM SDK: 初始化 SDK 并登录 IM
note over NIM SDK: 注册监听并登录圈组
申请方 ->> NIM SDK: 监听圈组系统通知
管理员 ->> NIM SDK: 监听圈组系统通知
申请方 ->> NIM SDK: 登录圈组
管理员 ->> NIM SDK: 登录圈组
note over NIM SDK: 发起申请
申请方 ->> NIM SDK: 申请加入服务器
NIM SDK ->> 管理员: 申请加入的系统通知
note over 管理员: 管理员必须拥有<br>"处理加入服务器申请"的权限
note over 管理员: 管理员从系统通知获取requestId、<br>serverId和申请者的accid
note over NIM SDK: 接受申请
管理员 ->> NIM SDK: 接受申请
note over 管理员: 接受申请时需传入requestId、<br>serverId和申请者的accid
NIM SDK ->> 申请方: 申请被接受 & 申请方加入服务器的系统通知

NIMQChatApplyServerJoinParam *param = [[NIMQChatApplyServerJoinParam alloc] init];
param.serverId = 123456;
id <NIMQChatServerManager> qchatServerManager = [[NIMSDK sharedSDK] qchatServerManager];
[qchatServerManager applyServerJoin:param
                         completion:^(NSError *error) {
    // your code
}];

通过邀请码加入

用户可通过服务器成员分享的邀请码（通过第三方应用分享，如微信）加入服务器。

1. 用户A 调用generateInviteCode:completion:方法生成邀请码。调用时必须传入服务器 ID（serverId），邀请码有效期可不传。

   拥有“邀请他人加入服务器的权限”（NIMQChatPermissionTypeInviteToServer）的服务器成员才能生成邀请码。权限通过身份组进行配置和管理，具体请参见身份组概述及其他身份组相关文档。

   
   

   示例代码如下：

   NIMQChatGenerateInviteCodeParam *param = [NIMQChatGenerateInviteCodeParam alloc] init];
   param.serverId = 543245;
   param.ttl = 543632;
   
   [[NIMSDK sharedSDK].qchatServerManager generateInviteCode:param completion:^(NSError *__nullable error, NIMQChatGenerateInviteCodeResult *__nullable result) {
       //code 
   }];
   

2. 用户B 调用joinByInviteCode:completion:方法，通过邀请码加入服务器。 调用时必须传入服务器ID 和邀请码。

   示例代码如下：

   NIMQChatJoinByInviteCodeParam *param = [NIMQChatJoinByInviteCodeParam alloc] init];
   param.serverId = 543245;
   param.inviteCode = @"543632";
   
   [[NIMSDK sharedSDK].qchatServerManager joinByInviteCode:param completion:^(NSError * _Nullable error) {
       //code 
   }];
   

退出服务器

用户既可以主动退出服务器，也可以被动退出，即被其他用户踢出服务器。

主动退出服务器

加入服务器后如不想继续待在此服务器中，用户可以调用leaveServer:completion:方法主动退出，调用时需传入服务器 ID。离开后将不再接收该服务器下的消息和通知。

示例代码如下：

NIMQChatLeaveServerParam *param = [[NIMQChatLeaveServerParam alloc] init];
param.serverId = 123456;
id <NIMQChatServerManager> qchatServerManager = [[NIMSDK sharedSDK] qchatServerManager];
[qchatServerManager leaveServer:param
                     completion:^(NSError *error) {
    // your code
}];

踢出服务器成员

调用kickServerMembers:completion:方法将其他成员踢出服务器。调用时需要传入当前服务器 ID（serverId）和需要被踢出用户的accid列表。

示例代码如下：

NIMQChatKickServerMembersParam *param = [[NIMQChatKickServerMembersParam alloc] init];
param.serverId = 123456;
param.accids = @[@"yunxin1", @"yunxin2", @"yunxin3"];
id <NIMQChatServerManager> qchatServerManager = [[NIMSDK sharedSDK] qchatServerManager];
[qchatServerManager kickServerMembers:param
                           completion:^(NSError *error) {
    // your code
}];

修改成员信息

V9.9.2 新增 “圈组用户资料复用 IM 用户资料” 的能力。

• 如果某用户未配置自己的服务器成员信息，该用户进入服务器后的初始成员信息将直接复用对应的 IM 用户资料（目前仅支持复用昵称和头像）。

• 如果某用户在未配置自己的服务器成员信息的情况下修改了自己的 IM 用户资料（昵称或头像），系统通知（通知类型NIMQChatSystemNotificationTypeMyMemberInfoUpdated）将触发，通知该用户需要在哪些服务器重新获取资料。

修改自己的成员信息

调用updateMyMemberInfo:completion:方法可修改自己在当前服务器的成员信息。调用时需要传入对应的服务器 ID 以及相应的修改项。支持对成员昵称、头像和自定义扩展的修改，9.1.0版本后可设置反垃圾配置antispamBusinessId（更多圈组反垃圾相关说明请参见圈组内容审核）。

示例代码如下：

NIMQChatUpdateMyMemberInfoParam *param = [[NIMQChatUpdateMyMemberInfoParam alloc] init];
param.serverId = 123456;
param.nick = @"我的新昵称";
//反垃圾业务id
param.antispamBusinessId = @"{\"picbid\": \"804265342b7425324f53425c343454\", \"txtbid\": \"804265342b7425324f53425c343454\"}";
id <NIMQChatServerManager> qchatServerManager = [[NIMSDK sharedSDK] qchatServerManager];
[qchatServerManager updateMyMemberInfo:param
                            completion:^(NSError * error, NIMQChatServerMember * result) {
    // your code
}];

修改他人的成员信息

调用updateServerMemberInfo:completion:方法可修改其他成员的信息。

调用时需传入对应的服务器 ID （serverId）、待修改成员的账号（accid）以及相应的修改项。支持修改其他成员的昵称和头像，9.1.0版本后可设置反垃圾配置 QChatAntiSpamConfig。更多圈组反垃圾相关说明请参见圈组内容审核。

示例代码如下：

NIMQChatUpdateServerMemberInfoParam *param = [[NIMQChatUpdateServerMemberInfoParam alloc] init];
param.serverId = 123456;
param.nick = @"我的新昵称";
//反垃圾业务id
param.antispamBusinessId = @"{\"picbid\": \"804265342b7425324f53425c343454\", \"txtbid\": \"804265342b7425324f53425c343454\"}";
id <NIMQChatServerManager> qchatServerManager = [[NIMSDK sharedSDK] qchatServerManager];
[qchatServerManager updateServerMemberInfo:param
                                completion:^(NSError * error, NIMQChatServerMember * result) {
    // your code
}];

成员封禁管理

封禁服务器成员

拥有封禁他人权限（NIMQChatPermissionTypeManageBanServerMember）的用户可调用banServerMember:completion:方法封禁某位服务器成员。调用时需传入服务器 ID（serverId）和待封禁成员的账号（accid）。

被封禁的成员将直接被踢出服务器，且不能再申请加入服务器或被邀请加入服务器。某成员被封禁后，所有该服务器成员都会收到该封禁成员被踢的系统通知（NIMQChatSystemNotificationTypeServerMemberKick）。

示例代码如下：

NIMQChatUpdateServerMemberBanParam *param = [[NIMQChatUpdateServerMemberBanParam alloc] init];
param.serverId = 62363463;
param.targetAccid = @"lixiaolong";

[[NINSDK sharedSDK].qchatServerManager banServerMember:param completion:^{
    //code here
 }];

分页查询封禁成员列表

调用getServerBanedMembersByPage:completion:方法可分页查询某服务器下被封禁的成员列表。

该方法的入参包括服务器 ID （serverId）、查询时间戳（timeTag）和查询数量限制（limit)，timeTag传 0 表示当前时间，limit 默认 100。 如调用成功，该方法的回参结构NIMQChatGetServerBanedMembersByPageHandler返回被封禁成员列表NSArray< NIMQChatServerMemberBanInfo * > * 。

QChatBannedServerMember参数说明如下：

示例代码如下：

NIMQChatGetServerBanedMembersByPageParam *param = [[NIMQChatGetServerBanedMembersByPageParam alloc] init];
param.serverId = 62363463;
param.timetag = 0;
param.limit = 20;

[[NINSDK sharedSDK].qchatServerManager getServerBanedMembersByPage:param completion:^{
    //code here
 }];

解封服务器成员

调用unbanServerMember:completion:方法可将已封禁用户解封。调用时需要传入服务器ID（serverId）和待解封成员账号（accid）。待解封的成员账号，可通过调用getServerBanedMembersByPage:completion:方法获取。

被解封的用户可正常申请加入服务器或被邀请加入服务器。

示例代码如下：

NIMQChatUpdateServerMemberBanParam *param = [[NIMQChatUpdateServerMemberBanParam alloc] init];
param.serverId = 62363463;
param.targetAccid = @"lixiaolong";

[[NINSDK sharedSDK].qchatServerManager unbanServerMember:param completion:^{
    //code here
 }];

服务器成员查询

根据账号查询服务器成员

用户登录圈组且进入服务器后，如果需要检索当前服务器内的成员，可调用getServerMembers:completion:方法查询多个服务器成员的信息。 调用时需传入由服务器 ID （serverId）和 IM 账号（accid）组成的键值对列表（NSArray<NIMQChatGetServerMemberItem *>*）。

示例代码如下：

NIMQChatGetServerMembersParam *param = [[NIMQChatGetServerMembersParam alloc] init];
param.serverAccids = @[@"yunxin1", @"yunxin2", @"yunxin3"];
id <NIMQChatServerManager> qchatServerManager = [[NIMSDK sharedSDK] qchatServerManager];
[qchatServerManager getServerMembers:param
                          completion:^(NSError * error, NIMQChatGetServerMembersResult * result) {
    // your code
}];

分页查询服务器成员

用户登录圈组且进入服务器后，如需要获取当前服务器的成员，可调用getServerMembersByPage:completion:方法可按成员加入服务器的时间倒序（由近及远）分页查询圈组的服务器列表。

示例代码如下：

NIMQChatGetServerMembersByPageParam *param = [[NIMQChatGetServerMembersByPageParam alloc] init];
// 传0拉取最新的成员
param.timeTag = 0;
param.limit = 20;
id <NIMQChatServerManager> qchatServerManager = [[NIMSDK sharedSDK] qchatServerManager];
[qchatServerManager getServerMembersByPage:param
                                completion:^(NSError * error, NIMQChatGetServerMemberListByPageResult * result) {
    // your code
}];

申请与邀请记录查询

查询服务器记录

调用getInviteApplyRecordOfServer:completion:方法可查询服务器下的申请与邀请记录。调用时需要传入服务器 ID， 其他参数值可为空。

示例代码如下：

NIMQChatGetInviteApplyRecordOfServerParam *param = [[NIMQChatGetInviteApplyRecordOfServerParam alloc] init];
param.serverId = 534543;
param.fromTime = 1665342532;
param.toTime = 167543256;
param.limit = 20;

[[NIMSDK sharedSDK].qchatServerManager getInviteApplyRecordOfServer:param completion:^(NSError * _Nullable error, NIMQChatGetInviteApplyHistoryByServerResult * _Nullable result) {
    // your code  
}];

查询自己的记录

用户如果需要查询自己的申请或邀请记录，可调用getInviteApplyRecordOfSelf方法进行查询。

示例代码如下：

NIMQChatGetInviteApplyRecordOfSelfParam *param = [[NIMQChatGetInviteApplyRecordOfSelfParam alloc] init];
param.serverId = 534543;
param.fromTime = 1665342532;
param.toTime = 167543256;
param.limit = 20;

[[NIMSDK sharedSDK].qchatServerManager getInviteApplyRecordOfSelf:param completion:^(NSError * _Nullable error, NIMQChatGetInviteApplyHistorySelfResult * _Nullable result) {
    // your code  
}];

相关系统通知

圈组系统通知的类型在NIMQChatSystemNotificationType枚举中定义，与服务器成员管理相关的内置系统通知类型如下：