Type Alias RoomData

A class that stores the complete summary of properties of a room. This instance is only received from the backend.

type RoomData = {
    copy(): RoomData;
    data: RoomDataDetails;
    dist: number;
    endpoint: string;
    id: string;
    owner: { name: string; type: int8 } | null;
}

Properties

Details of this room.

dist: number

The calculated distance of this room to a specific GeoLocation. Use Utils.calculateAllRoomDistances to calculate this value automatically.

endpoint: string

Endpoint of this room. You have to use this value in Room.join.

id: string

Id of this room. You have to use this value in Room.join.

owner: { name: string; type: int8 } | null

Owner of this room.