Online List

聊天室模块(chat) provides user list related APIs for developers to implement features such as online user count and online user list.

1. Start Online User List Polling

Description: Polls the online user list every 1 minute. It triggers immediately upon invocation.

API Method: startOnlineUserListPolling(): void

Supported from version v1.8.0

2. Stop Online User List Polling

API Method: stopOnlineUserListPolling(): void

Supported from version v1.8.0

3. New API for Retrieving Online User List

API Method: getOnlineUserListNew(): Promise<UserListResult>

Supported from version v1.8.0

Return Value Description: Type Promise<UserListResult>, detailed type description as follows:

Example:

const result = await watchCore.chat.getOnlineUserListNew();
console.log('在线列表：', result.userlist);

4. Get Real-Time Online User Count in Chat Room

Obtain the real-time online user count via getOnlineUserCount. The ChatEvents.OnlineUserCountChange event listens for changes in the chat room's online user count.

API Method: getOnlineUserCount(): number

Return Value Description: Real-time online user count

Example:

const onlineUserCount = watchCore.chat.getOnlineUserCount();
console.log('当前聊天室在线人数：', onlineUserCount);

// 监听人数改变
watchCore.chat.eventEmitter.on(ChatEvents.OnlineUserCountChange, (data) => {
  console.log('在线人数改变：', data.onlineUserCount);
});