Interface UseRoomResponse

The return type for the useRoom hook.

interface UseRoomResponse {
    attach: (() => Promise<void>);
    connectionError?: ErrorInfo;
    connectionStatus: ConnectionStatus;
    detach: (() => Promise<void>);
    room?: Room;
    roomError?: ErrorInfo;
    roomId: string;
    roomStatus: RoomStatus;
}

Hierarchy (view full)

Properties

attach connectionError? connectionStatus detach room? roomError? roomId roomStatus

Properties

attach

attach: (() => Promise<void>)

Shortcut to Room.attach. Not needed if the ChatRoomProvider has attach=true set, which is the default.

Optional ReadonlyconnectionError

connectionError?: ErrorInfo

If there's a connection error it will be available here.

ReadonlyconnectionStatus

connectionStatus: ConnectionStatus

Provides the connection status of the Ably connection.

detach

detach: (() => Promise<void>)

Shortcut to Room.detach. Not needed if the ChatRoomProvider has attach=true or release=true set, which are the default values.

Optionalroom

room?: Room

The room object.

Optional ReadonlyroomError

roomError?: ErrorInfo

If there's an error with the room it will be available here.

ReadonlyroomId

roomId: string

The id of the room.

ReadonlyroomStatus

roomStatus: RoomStatus

Provides the status of the room.

Settings

Member Visibility

On This Page

Properties