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

    Interface UseRoomReactionsParams

    The parameters for the useRoomReactions hook.

    interface UseRoomReactionsParams {
        listener?: RoomReactionListener;
        onConnectionStatusChange?: (change: ConnectionStatusChange) => void;
        onDiscontinuity?: DiscontinuityListener;
        onRoomStatusChange?: (change: RoomStatusChange) => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    listener? onConnectionStatusChange? onDiscontinuity? onRoomStatusChange?

    Properties

    listener?: RoomReactionListener

    A listener that will be called whenever a reaction is sent to the room.

    useRoomReactions({
      listener: (reactionEvent) => {
        console.log('Room reaction received:', reactionEvent.reaction.name, " from ", reactionEvent.reaction.clientId);
      }
    });
    onConnectionStatusChange?: (change: ConnectionStatusChange) => void

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

    Type Declaration

    onDiscontinuity?: DiscontinuityListener

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

    The error that caused the discontinuity.

    onRoomStatusChange?: (change: RoomStatusChange) => void

    Register a callback for when the room status changes.

    Type Declaration

    Settings

    Member Visibility

    On This Page

    Properties