Publish an annotation removal request for a message, to remove it from the summary summaries. The semantics of the delete (and what fields are required) are different for each annotation type; see annotation types documentation for more details.
The message which has an annotation that you want to delete.
The annotation deletion request. (Must include at least the
type, other required fields depend on the type).
Publish an annotation removal request for a message, to remove it from the summary summaries. The semantics of the delete (and what fields are required) are different for each annotation type; see annotation types documentation for more details.
The serial field of the message which has an annotation that you want to delete.
The annotation deletion request. (Must include at least the
type, other required fields depend on the type).
Get all annotations for a given message (as a paginated result)
The message to get annotations for.
Restrictions on which annotations to get (in particular a limit)
Get all annotations for a given message (as a paginated result) (alternative form where you only have the serial of the message, not a complete Message object)
The serial of the message to get annotations for.
Restrictions on which annotations to get (in particular a limit)
Publish a new annotation for a message.
The message to annotate.
The annotation to publish. (Must include at least the type;
other required fields depend on the annotation type).
Publish a new annotation for a message (alternative form where you only have the serial of the message, not a complete Message object)
The serial field of the message to annotate.
The annotation to publish. (Must include at least the type;
other required fields depend on the annotation type).
Registers a listener that is called each time an Annotation matching a given type is received on the channel. Note that if you want to receive individual realtime annotations (instead of just the rolled-up summaries), you will need to request the annotation_subscribe ChannelMode in ChannelOptions, since they are not delivered by default. In general, most clients will not bother with subscribing to individual annotations, and will instead just look at the summary updates.
A specific type string or an array of them to register the listener for.
Optional listener: messageCallback<Annotation>
An event listener function.
A promise which resolves upon success of the channel attach() operation and rejects with an ErrorInfo object upon its failure.
Registers a listener that is called each time an Annotation is received on the channel. Note that if you want to receive individual realtime annotations (instead of just the rolled-up summaries), you will need to request the annotation_subscribe ChannelMode in ChannelOptions, since they are not delivered by default. In general, most clients will not bother with subscribing to individual annotations, and will instead just look at the summary updates.
Optional listener: messageCallback<Annotation>
An event listener function.
A promise which resolves upon success of the channel attach() operation and rejects with an ErrorInfo object upon its failure.
Deregisters a specific listener that is registered to receive Annotation on the channel for a given type.
A specific annotation type (or array of types) to deregister the listener for.
An event listener function.
Deregisters any listener that is registered to receive Annotation on the channel for a specific type.
A specific annotation type (or array of types) to deregister the listeners for.
Deregisters a specific listener that is registered to receive Annotation on the channel.
An event listener function.
Deregisters all listeners currently receiving Annotation for the channel.
Generated using TypeDoc
Functionality for annotating messages with small pieces of data, such as emoji reactions, that the server will roll up into the message as a summary.