群组查询
本文档指导您如何使用融云即时通讯(IM)Harmony IMLib SDK 实现获取已加入群组、获取指定群组资料等功能。
提示
此功能从 1.8.0 版本开始支持。
开通服务
使用此功能前,您需要在控制台开通信息托管服务。
群组查询
您可以查询或搜索已加入的群组。
获取群组资料
调用 getGroupsInfo
方法获取群组资料。
- 该方法优先从本地查找,当用户不在群组中时,本地不存在或本地群组信息缓存超过 10 分钟才会从服务端拉取最新信息。
- 单次调用最多支持获取 20 个群组资料。
代码示例
TypeScript
// 群组 ID 列表
let groupIds = ["group1Id", "group2Id"];
IMEngine.getInstance().getGroupsInfo(groupIds).then(result => {
if (EngineError.Success !== result.code) {
// 获取群组信息失败
return;
}
// 获取群组信息成功
let ret : Object = result;
if (result.data) {
ret = Array.from(result.data as Array<GroupInfo>);
}
});
获取指定已加入群组的资料
使用 getJoinedGroups
根据当前用户已加入的群组 ID 获取群组资料。
该接口支持批量获取,您可以一次传入多个 groupId
获取多个群组资料,最多不超过 20 个。
代码示例
TypeScript
// 群组 ID 列表
let groupIds = ["group1Id", "group2Id"];
IMEngine.getInstance().getJoinedGroups(groupIds).then(result => {
if (EngineError.Success !== result.code) {
// 获取失败
return;
}
// 获取成功
let ret: object = result;
if (result.data) {
ret = Array.from(result.data as Array<GroupInfo>);
}
});
按角色获取已加入群组的资料
使用 getJoinedGroupsByRole
按群成员角色分页获取已加入的群组。
此接口支持返回本次查询条件的总数,见 PagingQueryResult 的 totalCount
。