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

服务器成员定义

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

使用限制

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

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

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

前提条件

在开始调用相关方法前，请确保：

• 服务器已创建。

• 已注册onReceiveSystemNotification事件流，监听系统通知的接收。

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

实现方法

加入服务器

邀请用户加入

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

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

sequenceDiagram



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

dartfinal param = QChatInviteServerMembersParam(serverId, [accId1, accId2])
  ..postscript = "邀请你加入测试服务器";
NimCore.instance.qChatServerService.inviteServerMembers(param).then((value) {
  if (value.isSuccess) {
    // 邀请成功,会返回因为用户服务器数量超限导致失败的accid列表
    var servers = value.data?.failedAccids;
  } else {
    // 邀请失败
  }
});

申请加入

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

sequenceDiagram



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

dartfinal param = QChatApplyServerJoinParam(serverId)
  ..postscript = "申请加入服务器";
NimCore.instance.qChatServerService.applyServerJoin(param).then((value) {
  if (value.isSuccess) {
    // 申请加入服务器成功
  } else {
    // 申请加入服务器失败
  }
});

通过邀请码加入

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

1. 用户A 调用generateInviteCode方法生成邀请码。

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

   
   

   示例代码如下：

   dartfinal param = QChatGenerateInviteCodeParam(serverId)
     ..ttl = 24 * 60 * 60 * 1000;//设置过期时间为1天
   NimCore.instance.qChatServerService.generateInviteCode(param).then((value) {
     if (value.isSuccess) {
       // 生成邀请码成功
     } else {
       // 生成邀请码失败
     }
   });
   

2. 用户B 调用joinByInviteCode方法，通过邀请码加入服务器。

   示例代码如下：

   dartfinal param = QChatJoinByInviteCodeParam(serverId, inviteCode);
   NimCore.instance.qChatServerService.joinByInviteCode(param).then((value) {
     if (value.isSuccess) {
       // 通过邀请码加入服务器成功
     } else {
       // 通过邀请码加入服务器失败
     }
   });
   

退出服务器

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

主动退出服务器

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

示例代码如下：

dartfinal param = QChatLeaveServerParam(serverId);
NimCore.instance.qChatServerService.leaveServer(param).then((value) {
  if (value.isSuccess) {
    // 离开Server成功
  } else {
    // 离开Serve失败
  }
});

踢出服务器成员

调用kickServerMembers方法将其他成员踢出服务器。

示例代码如下：

dartfinal param = QChatKickServerMembersParam(serverId, [accId1, accId2]);
NimCore.instance.qChatServerService.kickServerMembers(param).then((value) {
  if (value.isSuccess) {
    // 踢除成员成功
  } else {
    // 踢除成员失败
  }
});

修改成员信息

修改自己的成员信息

调用updateMyMemberInfo方法可修改自己在当前服务器的成员信息。

示例代码如下：

dartfinal antiSpamConfig = QChatAntiSpamConfig()
  ..antiSpamBusinessId = "用户配置的对某些资料内容另外的反垃圾的业务ID";
final param = QChatUpdateMyMemberInfoParam(serverId)
  ..nick = "昵称2"
  ..custom = "xxxxx"
  ..antiSpamConfig = antiSpamConfig;
NimCore.instance.qChatServerService.updateMyMemberInfo(param).then((value) {
  if (value.isSuccess) {
    // 修改成员信息成功,返回最新的成员信息
    var member = value.data?.member;
  } else {
    // 修改成员信息失败
  }
});

修改他人的服务器成员信息

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

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

示例代码如下：

dartfinal antiSpamConfig = QChatAntiSpamConfig()
  ..antiSpamBusinessId = "用户配置的对某些资料内容另外的反垃圾的业务ID";
final param = QChatUpdateServerMemberInfoParam(serverId, accId, nick: '新昵称')
  ..antiSpamConfig = antiSpamConfig;
NimCore.instance.qChatServerService.updateServerMemberInfo(param).then((value) {
  if (value.isSuccess) {
    // 修改成员信息成功,返回最新的成员信息
    var member = value.data?.member;
  } else {
    // 修改成员信息失败
  }
});

成员封禁管理

封禁服务器成员

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

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

示例代码如下：

dartfinal param = QChatBanServerMemberParam(serverId, accId);
NimCore.instance.qChatServerService.banServerMember(param).then((value) {
  if (value.isSuccess) {
    // 操作成功
  } else {
    // 操作失败
  }
});

分页查询封禁成员列表

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

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

QChatBannedServerMember参数说明如下：

示例代码如下：

dartfinal param = QChatGetBannedServerMembersByPageParam(serverId, 0);
NimCore.instance.qChatServerService.getBannedServerMembersByPage(param).then((value) {
  if (value.isSuccess) {
    // 操作成功
    var serverMemberBanInfoList = value.data?.serverMemberBanInfoList;
  } else {
    // 操作失败
  }
});

解封服务器成员

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

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

示例代码如下：

dartfinal param = QChatUnbanServerMemberParam(serverId, accId);
NimCore.instance.qChatServerService.unbanServerMember(param).then((value) {
  if (value.isSuccess) {
    // 操作成功
  } else {
    // 操作失败
  }
});

查询服务器成员

分页查询服务器成员

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

示例代码如下：

dart// 当前时间往前查最多100条Server成员信息
final param = QChatGetServerMembersByPageParam(serverId, DateTime.now().millisecond, 100);
NimCore.instance.qChatServerService.getServerMembersByPage(param).then((value) {
  if (value.isSuccess) {
    // 查询Server成员信息成功,返回查询到的Server成员信息
    var serverMembers = value.data?.serverMembers;
  } else {
    // 查询Server成员信息失败
  }
});

根据账号 ID 查询服务器成员

用户登录圈组且进入服务器后，如果需要检索当前服务器内的成员，可调用getServerMembers方法来了解相应的成员信息。调用时需传入由成员的 accid和服务器 ID 组成的 PairIntWithString 列表。

示例代码如下：

dartvar serverIdAccidPairList = [PairIntWithString(serverId, accId1), PairIntWithString(serverId, accId2)];
final param = QChatGetServerMembersParam(serverIdAccidPairList);
NimCore.instance.qChatServerService.getServerMembers(param).then((value) {
  if (value.isSuccess) {
    // 查询Server成员信息成功,返回查询到的Server成员信息
    var serverMembers = value.data?.serverMembers;
  } else {
    // 查询Server成员信息失败
  }
});

相关系统通知

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