Interface Room

Represents a chat room.

interface Room {
    get error(): undefined | ErrorInfo;
    get messages(): Messages;
    get occupancy(): Occupancy;
    get presence(): Presence;
    get reactions(): RoomReactions;
    get roomId(): string;
    get status(): RoomStatus;
    get typing(): Typing;
    attach(): Promise<void>;
    detach(): Promise<void>;
    offAllStatusChange(): void;
    onStatusChange(listener: RoomStatusListener): OnRoomStatusChangeResponse;
    options(): RoomOptions;
}

Index

Accessors

error messages occupancy presence reactions roomId status typing

Methods

attach detach offAllStatusChange onStatusChange options

Accessors

error

get error(): undefined | ErrorInfo
The current error, if any, that caused the room to enter the current status.

Returns undefined | ErrorInfo
- Defined in src/core/room.ts:81

messages

get messages(): Messages
Allows you to send, subscribe-to and query messages in the room.

Returns Messages
The messages instance for the room.
- Defined in src/core/room.ts:37

occupancy

get occupancy(): Occupancy
Allows you to interact with occupancy metrics for the room.

Returns Occupancy
The occupancy instance for the room.

Throws
ErrorInfo if occupancy is not enabled for the room.
- Defined in src/core/room.ts:69

presence

get presence(): Presence
Allows you to subscribe to presence events in the room.

Returns Presence
The presence instance for the room.

Throws
ErrorInfo} if presence is not enabled for the room.
- Defined in src/core/room.ts:45

reactions

get reactions(): RoomReactions
Allows you to interact with room-level reactions.

Returns RoomReactions
The room reactions instance for the room.

Throws
ErrorInfo if reactions are not enabled for the room.
- Defined in src/core/room.ts:53

roomId

get roomId(): string
The unique identifier of the room.

Returns string
The room identifier.
- Defined in src/core/room.ts:30

status

get status(): RoomStatus
The current status of the room.

Returns RoomStatus
The current status.
- Defined in src/core/room.ts:76

typing

get typing(): Typing
Allows you to interact with typing events in the room.

Returns Typing
The typing instance for the room.

Throws
ErrorInfo if typing is not enabled for the room.
- Defined in src/core/room.ts:61

Methods

attach

attach(): Promise<void>
Attaches to the room to receive events in realtime.

If a room fails to attach, it will enter either the RoomStatus.Suspended or RoomStatus.Failed state.

If the room enters the failed state, then it will not automatically retry attaching and intervention is required.

If the room enters the suspended state, then the call to attach will reject with the ErrorInfo that caused the suspension. However, the room will automatically retry attaching after a delay.

Returns Promise<void>
A promise that resolves when the room is attached.
- Defined in src/core/room.ts:107

detach

detach(): Promise<void>
Detaches from the room to stop receiving events in realtime.

Returns Promise<void>
A promise that resolves when the room is detached.
- Defined in src/core/room.ts:114

offAllStatusChange

offAllStatusChange(): void
Removes all listeners that were added by the onStatusChange method.

Returns void
- Defined in src/core/room.ts:93

onStatusChange

onStatusChange(listener): OnRoomStatusChangeResponse
Registers a listener that will be called whenever the room status changes.
Parameters
- listener: RoomStatusListener
  The function to call when the status changes.
Returns OnRoomStatusChangeResponse
An object that can be used to unregister the listener.
- Defined in src/core/room.ts:88

options

options(): RoomOptions
Returns the room options.

Returns RoomOptions
A copy of the options used to create the room.
- Defined in src/core/room.ts:121