@ably/chat - v0.10.0
    Preparing search index...

    Interface RoomReactions

    This interface is used to interact with room-level reactions in a chat room: subscribing to reactions and sending them.

    Get an instance via Room.reactions.

    interface RoomReactions {
        send(params: SendReactionParams): Promise<void>;
        subscribe(listener: RoomReactionListener): Subscription;
    }
    Index

    Methods

    Methods

    • Send a reaction to the room including some metadata.

      This method accepts parameters for a room-level reaction. It accepts an object

      Parameters

      • params: SendReactionParams

        an object containing {name, headers, metadata} for the room reaction to be sent. Name is required, metadata and headers are optional.

      Returns Promise<void>

      The returned promise resolves when the reaction was sent. Note that it is possible to receive your own reaction via the reactions listener before this promise resolves.

      If the Connection is not in the Connected state.