線上列表

聊天室模块(chat) 提供使用者列表相關 API，用於開發者開發線上人數、線上列表等功能。

一、開始線上使用者列表輪詢

說明： 每隔 1 分鐘輪詢線上使用者列表，呼叫後會立即觸發一次

API 方法： startOnlineUserListPolling(): void

從 v1.8.0 版本開始支援

二、結束線上使用者列表輪詢

API 方法： stopOnlineUserListPolling(): void

從 v1.8.0 版本開始支援

三、取得線上使用者列表新介面

API 方法： getOnlineUserListNew(): Promise<UserListResult>

從 v1.8.0 版本開始支援

回傳值說明： Promise<UserListResult> 類型，詳細類型說明如下

範例：

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

四、取得聊天室的即時線上人數

透過 getOnlineUserCount 取得即時線上人數，ChatEvents.OnlineUserCountChange 事件監聽聊天室線上人數的改變。

API 方法： getOnlineUserCount(): number

回傳值說明： 即時線上人數

範例：

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

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