Function roomStatus

  • roomStatus(room): Promise<{
        members: Record<string, AsyncReturnType<typeof sanitizeMemberDetails>>;
        membersCount: number;
        room: string;
    }>

  • Learn about the connections in the room. Returns a hash of the form { room: room, members: cleanedMembers, membersCount: count }. Members is an array of connections in the room sanitized via api.chatRoom.sanitizeMemberDetails

    Parameters

    • room: string

    Returns Promise<{
        members: Record<string, AsyncReturnType<typeof sanitizeMemberDetails>>;
        membersCount: number;
        room: string;
    }>

Settings

Member Visibility