Interface UsePresenceParams

The options for the usePresence hook.

interface UsePresenceParams {
    enterWithData?: unknown;
    leaveWithData?: unknown;
    onConnectionStatusChange?: (change: ConnectionStatusChange) => void;
    onDiscontinuity?: DiscontinuityListener;
    onRoomStatusChange?: (change: RoomStatusChange) => void;
}

Hierarchy (View Summary)

StatusParams
- UsePresenceParams

Index

Properties

enterWithData? leaveWithData? onConnectionStatusChange? onDiscontinuity? onRoomStatusChange?

Properties

`Optional`enterWithData

enterWithData?: unknown

The data to enter the room with. Any JSON serializable data can be provided.

`Optional`leaveWithData

leaveWithData?: unknown

The data to leave the room with. Any JSON serializable data can be provided.

`Optional`onConnectionStatusChange

onConnectionStatusChange?: (change: ConnectionStatusChange) => void

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

Type declaration

- (change: ConnectionStatusChange): void
- Parameters
  - change: ConnectionStatusChange
    Object representing the change in connection status.
  Returns void

`Optional`onDiscontinuity

onDiscontinuity?: DiscontinuityListener

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

Param: error

The error that caused the discontinuity.

`Optional`onRoomStatusChange

onRoomStatusChange?: (change: RoomStatusChange) => void

Register a callback for when the room status changes.

Type declaration

- (change: RoomStatusChange): void
- Parameters
  - change: RoomStatusChange
    Object representing the change in room status.
  Returns void