Interface SendReactionParams

Params for sending a room-level reactions. Only type is mandatory.

interface SendReactionParams {
    headers?: Headers;
    metadata?: Metadata;
    type: string;
}

Properties

headers?: Headers

Optional headers of the room reaction.

The headers are a flat key-value map and are sent as part of the realtime message's extras inside the headers property. They can serve similar purposes as the metadata but they are read by Ably and can be used for features such as subscription filters.

Do not use the headers for authoritative information. There is no server-side validation. When reading the headers treat them like user input.

metadata?: Metadata

Optional metadata of the reaction.

The metadata is a map of extra information that can be attached to the room reaction. It is not used by Ably and is sent as part of the realtime message payload. Example use cases are custom animations or other effects.

Do not use metadata for authoritative information. There is no server-side validation. When reading the metadata treat it like user input.

type: string

The type of the reaction, for example an emoji or a short string such as "like".

It is the only mandatory parameter to send a room-level reaction.