房间资料管理

功能简介

ZIM SDK 提供了房间信息查询功能，比如获取房间成员列表、查询在线人数等。

实现流程

说明

用户只有在所查询的房间内，才可以使用以下房间功能。

查询房间成员列表

如果用户加入房间后，想要了解此房间的成员构成，可以调用 queryRoomMemberList 接口，传入参数 roomID，config，然后通过 ZIMRoomMemberQueriedResult 回调接口，返回房间内成员列表。

其中，参数 config 表示查询房间成员操作的配置，需要通过 ZIMRoomMemberQueryConfig 类的以下参数进行配置：

参数	参数类型	是否必填	描述
nextFlag	string	是	分页查询的标识位。首次查询时，请将此字段设为空字符串。若回调的 "nextFlag" 字段不是空字符串，说明还未查询完所有用户，此时需要将其设置为当前位置，以继续下一页的查询。
count	number	是	查询一次，可获取的成员数量。注意事项：分页获取消息以降低开销，建议单次获取 100 个成员以内。

参数

参数类型

是否必填

描述

nextFlag

string

是

分页查询的标识位。首次查询时，请将此字段设为空字符串。

若回调的 "nextFlag" 字段不是空字符串，说明还未查询完所有用户，此时需要将其设置为当前位置，以继续下一页的查询。

count

number

是

查询一次，可获取的成员数量。

注意事项：分页获取消息以降低开销，建议单次获取 100 个成员以内。

说明

当房间成员超过 500 人时，查询房间成员列表的结果最多只能包含 500 名成员的信息。如需提高查询结果上限，请联系 ZEGO 技术支持进行配置。

const roomID = '';
const config: ZIMRoomMemberQueryConfig = { count: 10, nextFlag: '' };

zim.queryRoomMemberList(roomID, config)
    .then((res: ZIMRoomMemberQueriedResult) => {
        // 查询成功。
    })
    .catch((err: ZIMError) => {
        // 查询失败。
    });

const roomID = '';
const config: ZIMRoomMemberQueryConfig = { count: 10, nextFlag: '' };

zim.queryRoomMemberList(roomID, config)
    .then((res: ZIMRoomMemberQueriedResult) => {
        // 查询成功。
    })
    .catch((err: ZIMError) => {
        // 查询失败。
    });

批量查询房间用户信息

开发者可以通过调用 queryRoomMembers 接口，传入 roomID 、 userID 数组，批量查询房间中用户的信息。接口调用成功后，会返回查询成功的 userList（可用于确认目标用户在房间中），以及查询失败的 errorUserList（可用于确认目标用户不在房间中）。

说明

批量查询用户数量的默认上限为 10 名。

示例代码如下所示：


const userIDs = ['user1', 'user2'];

zim.queryRoomMembers(userIDs, 'roomID')
    .then((res: ZIMRoomMembersQueriedResult) => {
        // 这里写查询结果返回后的业务逻辑  
    });


const userIDs = ['user1', 'user2'];

zim.queryRoomMembers(userIDs, 'roomID')
    .then((res: ZIMRoomMembersQueriedResult) => {
        // 这里写查询结果返回后的业务逻辑  
    });

查询房间在线人数

用户还可以获取到房间内的在线人数，调用 queryRoomOnlineMemberCount 接口，输入 roomID，即可查询到房间内的在线人数。

const roomID = '';

zim.queryRoomOnlineMemberCount(roomID)
    .then((res: ZIMRoomOnlineMemberCountQueriedResult) => {
        // 查询成功。
    })
    .catch((err: ZIMError) => {
        // 查询失败。
    });

const roomID = '';

zim.queryRoomOnlineMemberCount(roomID)
    .then((res: ZIMRoomOnlineMemberCountQueriedResult) => {
        // 查询成功。
    })
    .catch((err: ZIMError) => {
        // 查询失败。
    });

说明

加入到房间后，如果调用了 logout 接口退出登录，该客户端即处于离线状态。

获取房间用户扩展字段信息

用户加入房间后，通过 ZIMUserInfo.userExtendedData 字段可获取到该用户进房前的扩展信息快照。此功能可以用于实现房间用户等级、VIP 用户标识等业务场景。

注意

此接口无法获取用户加入房间后修改的扩展字段信息（例如：进房前的 userExtendedData 为 extended1，进房后修改为 extended2，通过该接口获取的内容还是 extended1）。

相关接口请参考：queryRoomMemberList、queryRoomMembers、roomMemberJoined、roomMemberLeft。

说明

2.22.0 版本开始支持。
如需开启此功能请联系 ZEGO 技术支持。