logo
当前页

群成员管理


功能简介

说明

本文档适用于开发以下平台应用:iOS、Android、macOS、Windows。

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

实现流程

注意

用户使用“群成员管理”功能之前,请先加入某个群组,否则无法使用相关功能,详情请参考 加入群组

查询群成员列表

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

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

说明

截至当前版本,首次调用此接口拉取群成员列表时,可以获取群成员头像。再次调用此接口后,可以获取新增用户的头像信息,但存量用户的头像信息不会更新。

如需获取群成员最新头像,请调用接口 queryGroupMemberInfo 查询群成员信息

示例代码
// 群内成员查询群组的成员列表
ZIMGroupMemberQueryConfig config = new ZIMGroupMemberQueryConfig();
// count 超过 100 按照 100 处理
config.count = 100;
config.nextFlag = 0;
ZIM.GetInstance().QueryGroupMemberList("group_id", config, (string groupID, List<ZIMGroupMemberInfo> userList,
    uint nextFlag, ZIMError errorInfo) =>
    {
        // 通过 errorInfo.code 获取查询群组成员列表的结果     
    }
);
1
Copied!

查询群成员信息

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

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

示例代码
// 群内成员 查询群组内某个成员的信息
ZIM.GetInstance().QueryGroupMemberInfo("user_id", "group_id", (string groupID, ZIMGroupMemberInfo userInfo, ZIMError errorInfo) =>
    {
        // 通过 errorInfo.code 获取查询群组成员信息的结果     
    }
);
1
Copied!

设置群成员昵称

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

注意

在群组中,群主可以设置自己和其他群内成员在该群中的昵称;其他群内成员仅可以设置自己在该群的昵称。

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

示例代码
// 群内成员设置昵称。注意:群主可以设置自己和其他群内成员在该群的昵称;其他群内成员仅可以设置自己在该群的昵称。
ZIM.GetInstance().SetGroupMemberNickname("member_new_nick_name", "user_id", "group_id", (string groupID, string forUserID,
    string nickname, ZIMError errorInfo) =>
    {
        // 通过 errorInfo.code 获取设置昵称的结果
    }
);
1
Copied!

设置群成员角色

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

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

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

群成员角色与权限说明

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

客户端权限群主(对应枚举值为 1)管理员(对应枚举值为 2)普通成员(对应枚举值为 3)
修改群头像、群名称、群公告支持支持支持
修改群属性
修改群成员昵称支持,可对所有群角色用户使用此功能支持,可对所有普通成员使用此功能支持,仅可对自己使用此功能
撤回群成员消息
踢人不支持。
对单独群成员禁言
对特定群角色禁言
设置群成员角色不支持
转让群主
解散群组
全员禁言
示例代码
// 群主将普通成员用户设置为管理员
int role = 2;
ZIM.GetInstance().SetGroupMemberRole(role, "user_id", "group_id", (string groupID, string forUserID,
    int role, ZIMError errorInfo) =>
    {
        // 通过 errorInfo.code 获取设置群内成员的角色的结果
    }
);
1
Copied!

转让群主

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

注意
  • 群组中,只有群主向其他群内成员转让群主的角色。
  • 群主转让时,toUserID(被转让群主的用户 ID) 必须是本群组内的成员,否则会操作失败。

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

示例代码
// 转让群主身份给其他群内成员
ZIM.GetInstance().TransferGroupOwner("new_group_owner_id", "group_id", (string groupID, string toUserID, ZIMError errorInfo) =>
    {
        // 通过 errorInfo.code 获取转让群主身份的结果     
    }
);
1
Copied!

查询群内成员数量

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

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

示例代码
// 群内成员 查询群组内成员的数量
ZIM.GetInstance().QueryGroupMemberCount("GROUP_ID", (string groupID, uint count, ZIMError errorInfo) =>
    {
        // 获取群人数
    }
);
1
Copied!

搜索群成员

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

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

示例代码
// 在某个群组中搜索名称中包含 “zego” 的群成员
ZIMGroupMemberSearchConfig config = new ZIMGroupMemberSearchConfig();
config.count = 10;
config.nextFlag = nextFlag;
config.isAlsoMatchGroupMemberNickname = true; // 如果群成员昵称包含 zego,搜索结果将包含该成员
config.keywords.Add("zego");
ZIM.GetInstance().SearchLocalGroupMembers(groupInfo.baseInfo.groupID, groupMemberSearchConfig, (string groupID, List<ZIMGroupMemberInfo> userList,
        uint nextFlag, ZIMError errorInfo) =>
    {
        // 开发者可从 userList 中获取到群成员信息
    });
1
Copied!

Previous

群属性管理

Next

收发消息