群成员管理
本文档旨在指导开发者如何使用融云即时通讯 Android IMLib SDK 实现设置或查询群组成员资料,添加或删除群管理员等功能。
提示
此功能从 5.12.0 版本开始支持。
开通服务
使用此功能前,您须在控制台开通信息托管服务。
群成员
可以查询指定群的群成员,也可以设置群成员信息。
分页获取群成员信息
您可以使用 getGroupMembersByRole
按群成员角色分页获取群成员信息。
此接口支持返回本次查询条件的总数,见 PagingQueryOption 的getTotalCount()
。
群成员角色 GroupMemberRole
枚举介绍:
枚举值 | 群成员角色 |
---|---|
Undef | 未定义角色(使用此枚举查询代表查询全部类型群成员) |
Normal | 普通群成员 |
Manager | 管理员 |
Owner | 群主 |
提示
分页拉取说明:
- 首次拉取时,PagingQueryOption 的
pageToken
无需设置(不设置、设置null、设置"",效果等同)。 - 拉取第二页需要传入首次拉取返回结果 PagingQueryResult 类型中的
pageToken
。- 如果不为 "",则可以传入该值再次拉取,直至
pageToken
返回为 "",表示全部拉取完成。 - 如果为 "",表示没有下一页或已拉取完成,无需再次拉取。如传递 "",将视为拉取首页数据。
- 如果不为 "",则可以传入该值再次拉取,直至
代码示例
Java
{
//...
// 分页拉取参数(设置null与设置"",效果等同)
String pageToken = "";
getGroupMembersByRole(pageToken);
//...
}
public void getGroupMembersByRole(String pageToken) {
// 群Id
String groupId = "groupId";
// 通过 role 参数指定拉取全部群成员角色类型的群成员信息
GroupMemberRole role = GroupMemberRole.Undef;
// 分页请求参数
PagingQueryOption option = new PagingQueryOption();
// 设置分页大小,取值范围为 [1~100]。
option.setCount(20);
// 分页拉取参数
option.setPageToken(pageToken);
// 按加入群组时间正序、倒序获取。true:正序;false:倒序。
option.setOrder(false);
RongCoreClient.getInstance().getGroupMembersByRole(groupId, role, option, new IRongCoreCallback.PageResultCallback<GroupMemberInfo>() {
@Override
public void onSuccess(PagingQueryResult<GroupMemberInfo> result) {
if (!TextUtils.isEmpty(result.getPageToken())) {
// 使用返回的 pageToken 拉取下一页
getGroupMembersByRole(result.getPageToken());
} else {
// 拉取结束
}
}
@Override
public void onError(IRongCoreEnum.CoreErrorCode e) {
// 拉取失败
}
});
}