Interface TypingParams

The parameters for the useTyping hook.

interface TypingParams {
    listener?: TypingListener;
    onConnectionStatusChange?: ((change: ConnectionStatusChange) => void);
    onDiscontinuity?: ((error?: ErrorInfo) => void);
    onRoomStatusChange?: ((change: RoomStatusChange) => void);
}

Hierarchy (view full)

Properties

listener? onConnectionStatusChange? onDiscontinuity? onRoomStatusChange?

Properties

Optionallistener

listener?: TypingListener

A listener that will be called whenever a typing event is sent to the room. The listener is removed when the component unmounts.

OptionalonConnectionStatusChange

onConnectionStatusChange?: ((change: ConnectionStatusChange) => void)

Register a callback for when the connection status to Ably changes.

Type declaration

    • (change): void

    • Parameters

      Returns void

OptionalonDiscontinuity

onDiscontinuity?: ((error?: ErrorInfo) => void)

Register a callback to detect and respond to discontinuities. For example, you might choose to fetch missing messages.

Type declaration

    • (error?): void

    • Parameters

      • Optionalerror: ErrorInfo

        The error that caused the discontinuity.

      Returns void

OptionalonRoomStatusChange

onRoomStatusChange?: ((change: RoomStatusChange) => void)

Register a callback for when the room status changes.

Type declaration

    • (change): void

    • Parameters

      Returns void

Settings

Member Visibility

On This Page

Properties