@ably/chat - v1.1.1
    Preparing search index...

    Interface UseRoomParams

    The parameters for the useRoom hook.

    interface UseRoomParams {
        onConnectionStatusChange?: (change: ConnectionStatusChange) => void;
        onStatusChange?: (change: RoomStatusChange) => void;
    }
    Index

    Properties

    onConnectionStatusChange? onStatusChange?

    Properties

    onConnectionStatusChange?: (change: ConnectionStatusChange) => void

    Callback for when the connection status changes. The listener is removed when the component unmounts.

    Type Declaration

    useRoom({
      onConnectionStatusChange: (change) => {
        console.log(`Connection changed from ${change.previous} to ${change.current}`);
      },
    });
    onStatusChange?: (change: RoomStatusChange) => void

    Callback for when the room status changes. The listener is removed when the component unmounts.

    Type Declaration

    useRoom({
      onStatusChange: (change) => {
        console.log(`Room status changed from ${change.previous} to ${change.current}`);
      },
    });

    Settings

    Member Visibility

    On This Page

    Properties