@amityco/ts-sdk-react-native
Version:
Amity Social Cloud Typescript SDK
18 lines • 689 B
TypeScript
/**
* ```js
* import { getRoomOnlineUsers } from '@amityco/ts-sdk-react-native'
* const result = await getRoomOnlineUsers('roomId')
* ```
*
* Retrieves the list of users currently online in a specific room.
* This function fetches all users who are actively watching or present in the room,
* handling pagination automatically for large numbers of users.
*
* @param roomId The ID of the room to get online users for
* @returns Promise that resolves with a cached list of online users
*
* @category Room Presence API
* @async
*/
export declare const getRoomOnlineUsers: (roomId: string) => Promise<Amity.Cached<Amity.User[]>>;
//# sourceMappingURL=getRoomOnlineUsers.d.ts.map