logo
当前页

房间资料管理


功能简介

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

实现流程

说明

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

查询房间成员列表

如果用户加入房间后,想要了解此房间的成员构成,可以调用 queryRoomMemberListByRoomID 接口,传入参数 roomID,config,即可获取到房间内成员列表。

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

参数参数类型是否必填描述
nextFlagstring

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

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

countint

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

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

说明

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

Untitled
ZIMRoomMemberQueryConfig *config = [[ZIMRoomMemberQueryConfig alloc] init];
config.nextFlag = @"";
config.count = 1;//1 表示每次获取一个成员。
[zim queryRoomMemberListByRoomID:RoomID config:config callback:^(NSArray<ZIMUserInfo * > * _Nonnull memberList, NSString * _Nonnull nextFlag, ZIMError * _Nonnull errorInfo) {
    //在这里实现获取房间成员列表的事件回调。
}];
1
Copied!

查询房间在线人数

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

Untitled
[zim queryRoomOnlineMemberCountByRoomID:< #(nonnull NSString *) #> callback:^(NSString * _Nonnull roomID, unsigned int count, ZIMError * _Nonnull errorInfo) {
        //实现查询在线房间成员的事件回调。
}];
1
Copied!
说明

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

Previous

房间管理

Next

房间属性管理