Interface ChatStatusResponse

Common status variables for chat features. Most hooks in this library implement this interface.

interface ChatStatusResponse {
    connectionError?: ErrorInfo;
    connectionStatus: ConnectionStatus;
    roomError?: ErrorInfo;
    roomStatus: RoomStatus;
}

Hierarchy (View Summary)

ChatStatusResponse

Index

Properties

connectionError? connectionStatus roomError? roomStatus

Properties

`Optional` `Readonly`connectionError

connectionError?: ErrorInfo

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

`Readonly`connectionStatus

connectionStatus: ConnectionStatus

Provides the connection status of the Ably connection.

`Optional` `Readonly`roomError

roomError?: ErrorInfo

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

`Readonly`roomStatus

roomStatus: RoomStatus

Provides the status of the room.