@ably/chat - v0.8.0
    Preparing search index...

    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;
        roomName: string;
        roomStatus: RoomStatus;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attach connectionError? connectionStatus detach room? roomError? roomName roomStatus

    Properties

    attach: () => Promise<void>

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

    connectionError?: ErrorInfo

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

    connectionStatus: ConnectionStatus

    Provides the connection status of the Ably connection.

    detach: () => Promise<void>

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

    room?: Room

    The room object.

    roomError?: ErrorInfo

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

    roomName: string

    The unique identifier of the room.

    roomStatus: RoomStatus

    Provides the status of the room.

    Settings

    Member Visibility

    On This Page

    Properties