群成员管理

---

功能简介

ZIM SDK 提供了群成员管理功能，支持查询群组成员列表、查询群组成员基本信息以及转让群主等功能。

前提条件

在实现“群成员管理”功能之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 SDK”。

实现流程

查询群成员列表

用户登录 ZIM SDK、并加入某个群组后，如果想要了解自己所在群组都有哪些成员，可以通过调用 queryGroupMemberListByGroupID 接口，分页查询该群组的成员列表。单次调用接口最多可获取 100 名成员，传入 count 超过 100 按照 100 处理。

查询成功后，用户可以通过 ZIMGroupMemberListQueriedCallback 收到查询结果。

queryGroupMemberList 说明

- (void)queryGroupMemberListByGroupID:(NSString *)groupID
                               config:(ZIMGroupMemberQueryConfig *)config
                             callback:(ZIMGroupMemberListQueriedCallback)callback;

示例代码

// 群内成员查询群组的成员列表
int myNextFlag = 0;
ZIMGroupMemberQueryConfig *config = [[ZIMGroupMemberQueryConfig alloc] init];
// count 超过 100 按照 100 处理
config.count = 20;
config.nextFlag = myNextFlag;
[zim queryGroupMemberListByGroupID:groupID config:config callback:^(NSArray<ZIMGroupMemberInfo *> * _Nonnull userList, unsigned int nextFlag, ZIMError * _Nonnull errorInfo) {
    //保存群成员的锚点，用于下次分页查询
    myNextFlag = nextFlag;
    //这里写调用查询群成员接口后的业务代码
}];

查询群成员信息

用户登录 ZIM SDK、并加入某个群组后，如果想要了解自己所在群组的某个成员的信息，可以通过调用 queryGroupMemberInfoByUserID 接口，查询该成员的个人信息。

查询成功后，用户可以通过 ZIMGroupMemberInfoQueriedCallback 收到查询结果。

queryGroupMemberInfoByUserID 说明

- (void)queryGroupMemberInfoByUserID:(NSString *)userID
                             groupID:(NSString *)groupID
                            callback:(ZIMGroupMemberInfoQueriedCallback)callback;

示例代码

// 群内成员 查询群组内某个成员的信息
[zim queryGroupMemberInfo:userID groupID:groupID callback:^(NSString * _Nonnull groupID, ZIMGroupMemberInfo * _Nonnull userInfo, ZIMError * _Nonnull errorInfo) {
    //这里写调用查询群组内某个成员的信息接口后的业务代码
}];

设置群成员昵称

用户登录 ZIM SDK、并加入某个群组后，如果想要设置自己在群组中的昵称，可以通过调用 setGroupMemberNickname 接口，设置昵称。

设置成功后，用户可以通过 ZIMGroupMemberNicknameUpdatedCallback 收到通知。

setGroupMemberNickname 说明

- (void)setGroupMemberNickname:(NSString *)nickname
                     forUserID:(NSString *)foruserID
                       groupID:(NSString *)groupID
                      callback:(ZIMGroupMemberNicknameUpdatedCallback)callback;

示例代码

// 群内成员设置昵称。
// 注意：群主可以设置自己和其他群内成员在该群中的昵称；其他群内成员仅可以设置自己在该群中的昵称。
[zim setGroupMemberNickname:nickName forUserID:userID groupID:groupID callback:^(ZIMError * _Nonnull errorInfo) {
        //此处写调用设置群成员的别名接口后的业务代码
}];

设置群成员角色

群主登录 ZIM SDK 后，可以通过调用 setGroupMemberRole 接口，设置其他群内成员的角色，比如设置某个群成员为普通成员或者为管理员。

设置成功后，群主可以通过 ZIMGroupMemberRoleUpdatedCallback 类型收到设置结果。

群内成员可以通过 groupMemberInfoUpdated 收到用户角色变更的通知。

群成员角色与权限说明

ZIM SDK 默认支持将用户设置为群主、管理员、普通成员。在群组中，群主拥有所有客户端权限，可以实现所有群组功能。管理员拥有大部分客户端权限。普通成员拥有的客户端权限最少，具体如下表所示：

setGroupMemberRole 说明

- (void)setGroupMemberRole:(int)role
                    userID:(NSString *)userID
                   groupID:(NSString *)groupID
                  callback:(ZIMGroupMemberRoleUpdatedCallback)callback;

示例代码

// 群主设置普通成员为管理员
[zim setGroupMemberRole:2 forUserID:userID groupID:groupID callback:^(ZIMError * _Nonnull errorInfo) {
        //此处写设置角色后的业务代码
}];

转让群主

用户登录 ZIM SDK、并加入某个群组后，如果自己是某个群组中的群主，可以通过调用 transferGroupOwnerToUserID 接口，传入 toUserID（被转让群主的群成员 ID），将自己的群主角色，转让给其他群内成员。

转让成功后，群内成员可以通过 groupMemberInfoUpdated 收到群主变更的通知。

transferGroupOwnerToUserID 说明

- (void)transferGroupOwnerToUserID:(NSString *)toUserID
                           groupID:(NSString *)groupID
                          callback:(ZIMGroupOwnerTransferredCallback)callback;

示例代码

// 转让群主身份给其他群内成员
[zim transferGroupOwnerToUserID:userID groupID:groupID callback:^(ZIMError * _Nonnull errorInfo) {
        //此处写调用转让群主身份给其他群内成员的接口后的业务代码
}];

查询群内成员数量

用户登录 ZIM SDK、并加入某个群组后，如果想要了解自己所在群组的成员数量，可以通过调用 queryGroupMemberCountByGroupID 接口，查询该群成员的数量。

查询成功后，用户可以通过 ZIMGroupMemberCountQueriedCallback 收到查询结果。

queryGroupMemberCountByGroupID 说明

- (void)queryGroupMemberCountByGroupID:(NSString *)groupID
                              callback:(ZIMGroupMemberCountQueriedCallback)callback;

示例代码

// 群内成员 查询群组内成员的数量
[zim queryGroupMemberCountByGroupID:self.toGroupID callback:^(NSString * _Nonnull groupID, unsigned int count, ZIMError * _Nonnull errorInfo) {

}];

搜索群成员

用户登录 ZIM SDK、并加入群组后，如果想要根据条件在群成员中搜索用户，可以通过调用 searchLocalGroupMembersByGroupID 接口，传入 groupID、config、callback 搜索符合条件的群成员。

搜索结果将通过 ZIMGroupMembersSearchedCallback 回调接口返回。

searchLocalGroupMembersByGroupID 说明

- (void)searchLocalGroupMembersByGroupID:(NSString *)groupID
                                  config:(ZIMGroupMemberSearchConfig *)config
                                callback:(ZIMGroupMembersSearchedCallback)callback;

ZIMGroupMemberSearchConfig 参数说明

示例代码

// 在某个群组中搜索名称中包含 “zego” 的群成员
ZIMGroupMemberSearchConfig *config = [[ZIMGroupMemberSearchConfig alloc] init];
config.count = 10;
config.isAlsoMatchGroupMemberNickname = true; // 如果群成员昵称包含 zego，搜索结果将包含该成员
config.keywords = @[@"zego"];
[[ZIM getInstance] searchLocalGroupMembersByGroupID:@"groupID" config:config callback:^(NSString * _Nonnull groupID, NSArray<ZIMGroupMemberInfo *> * _Nonnull userList, unsigned int nextFlag, ZIMError * _Nonnull errorInfo) {
    // 开发者可从 userList 中获取到群成员信息
}];

设置群成员禁言状态

登录 ZIM SDK 后，用户可以禁言或解禁自己管理的群组内的特定成员。调用 muteGroupMembers 接口，批量修改 100 名群成员的禁言状态。禁言期限可为永久或最长 604800 秒（7 天）。

设置成功后，操作用户可以通过 ZIMGroupMembersMutedCallback 收到通知。

禁言或解禁成功后，全体群成员会收到 groupMemberInfoUpdated，得知哪些群成员无法在该群组发言或解除禁言状态。

ZIMGroupMemberMuteConfig *muteConfig = [[ZIMGroupMemberMuteConfig alloc] init];
// 禁言时长 30 秒
muteConfig.duration = 30;
[[ZIM getInstance] muteGroupMembers:YES userIDs:@[@"user_1",@"user_2",@"user_3"] groupID:@"group_id" config:muteConfig callback:^(NSString * _Nonnull groupID, BOOL isMute, int duration, NSArray<NSString *> * _Nonnull mutedMemberIDs, NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
    // 开发者可从回调各参数中获取到禁言结果相关信息
}];

查询群内禁言成员列表

登录 ZIM SDK 后，群成员如需了解所在群组的被禁言成员列表，可调用 queryGroupMemberMutedListByGroupID 接口进行查询。

查询成功后，操作用户可通过 ZIMGroupMemberMutedListQueriedCallback 获取具体信息。

// 群内成员查询群组的成员列表
ZIMGroupMemberMutedListQueryConfig *config = [[ZIMGroupMemberMutedListQueryConfig alloc] init];
// 单次获取成员数量为 100
config.count = 100;
config.nextFlag = 0;

[[ZIM getInstance] queryGroupMemberMutedListByGroupID:@"groupID" config:config callback:^(NSString * _Nonnull groupID, unsigned long long nextFlag, NSArray<ZIMGroupMemberInfo *> * _Nonnull userList, ZIMError * _Nonnull errorInfo) {
    // 开发者可以从 info 中拿到被禁言群成员信息
}];

获取当前群成员禁言状态

如需主动获取当前用户在群组的禁言状态，请通过以下任意方法：

• 参考 会话管理 - 拉取会话列表 主动拉取会话列表。
• 参考 会话管理 - 更新会话列表，监听会话变更回调，更新会话列表。

当会话类型是群类型时，从返回结果中的 ZIMGroupConversation 获取 mutedExpiredTime，即群禁言时间，单位为秒。

mutedExpiredTime 值说明如下：

• 为 -1 时，表示当前用户永久无法在该群组发言。
• 为 0 时，表示当前用户可以在该群组发言。
• 为其他值时，表示当前用户于该数值时间内无法在该群组发言。