跳到主要内容

群查询

本文档旨在指导开发者如何使用融云即时通讯 Web IMLib SDK 实现获取本人已加入的群组、获取指定群组资料等功能。

提示

此功能从 5.12.0 版本开始支持。

开通服务​

信息托管服务已默认开通，您可以直接使用此功能。

群查询​

可以查询或搜索我加入的群组。

获取群组资料​

您可以调用 getGroupsInfo 方法获取群组资料。支持获取已存在的所有群组信息。

提示

该方法优先本地查找，本地不存在或者本地群组信息缓存超过 10 分钟的会从服务端拉取最新的群组信息。

接口​

JavaScript
RongIMLib.getGroupsInfo(groupIds)

参数说明​

参数类型必填说明
groupIdsstring[]是群 ID 列表，单次查询最多支持 20 个群组

示例代码​

javascript
// 必填项，群 ID 数组，单次查询最多支持 20 个群组。
const groupIds = ['group001','group002']
const res = await RongIMLib.getGroupsInfo(groupIds);
console.info('获取群组资料列表', res);

获取指定已加入群组的资料​

您可以使用 getJoinedGroups 根据群 ID 获取当前用户已加入的群组。

接口​

JavaScript
RongIMLib.getJoinedGroups(groupIds)

参数说明​

参数类型必填说明
groupIdsstring[]是群 ID 列表，单次查询最多支持 20 个群组

示例代码​

javascript
const groupIds = ['group001', 'group002']; // 群组 ID 数组，一次最多查询 20 个群组
const res = await RongIMLib.getJoinedGroups(groupIds);
console.info('批量获取群组信息结果', res);

按角色获取已加入群组的资料​

您可以使用 getJoinedGroupsByRole 按群成员角色分页获取已加入的群组。

注意

Web 返回的 IPagingQueryResult 结构中暂不支持返回 totalCount。

接口​

JavaScript
RongIMLib.getJoinedGroupsByRole(option, role)

参数说明​

参数类型必填说明
optionIPagingQueryOption是分页拉取参数，一页最多查询 100 条数据。
option.countGroupMemberRole是群组身份。
分页拉取说明
  1. 首次拉取时，option 的 pageToken 参数可不传或传 ''，效果等同。
  2. 拉取下一页数据时，需传入上次接口返回结果中的 pageToken。
  • 当 pageToken 不为 ''，表示存在下一页，可继续拉取。
  • 当 pageToken 为 ''，表示数据已全部拉取完毕，继续传 '' 会视为拉取首页数据。

示例代码​

javascript
const option = {
    // 必填，范围 1 ~ 100
    count: 50,
}
const role = GroupMemberRole.UNDEF; // 群组身份, GroupMemberRole.UNDEF 不区分角色获取全部
const res = await RongIMLib.getJoinedGroupsByRole(option, role);
console.info('获取用户所在的群组结果', res);

// 拉取下一页
if (res && res.pageToken) {
    const nextRes = await RongIMLib.getJoinedGroupsByRole({
        ...option,
        pageToken:  res.pageToken
    }, role,);
    console.info('获取用户所在的群组，拉取下一页', nextRes);
}

按群名称搜索已加入群组的资料（Electron）​

您可以使用 searchJoinedGroups 搜索已加入的群组。

接口​

JavaScript
RongIMLib.searchJoinedGroups(groupName, option)

参数说明​

参数类型必填说明
groupNamestring是群名称搜索关键字。不能为空最长不超过 64 个字符，支持模糊搜索查询时需要去掉前后空格。
optionIPagingQueryOption否分页拉取参数，一页最多查询 200 条数据。
分页拉取说明
  1. 首次拉取时，option 的 pageToken 参数可不传或传 ''，效果等同。
  2. 拉取下一页数据时，需传入上次接口返回结果中的 pageToken。
  • 当 pageToken 不为 ''，表示存在下一页，可继续拉取。
  • 当 pageToken 为 ''，表示数据已全部拉取完毕，继续传 '' 会视为拉取首页数据。

示例代码 |​

javascript
const option = {
    // 必填，范围 1 ~ 200
    count: 50,
}
const groupName = 'groupName'; // 群名称搜索关键字。不能为空最长不超过 64 个字符，支持模糊搜索查询时需要去掉前后空格。
const res = await RongIMLib.searchJoinedGroups(groupName, option);
console.info('搜索已加入的群组', res);

// 拉取下一页
if (res && res.pageToken) {
    const nextRes = await RongIMLib.searchJoinedGroups(groupName, {
        ...option,
        pageToken:  res.pageToken
    });
    console.info('搜索已加入的群组，拉取下一页', nextRes);
}