The action, whether this is an annotation being added or removed, one of the AnnotationAction enum values.
Optional clientThe client ID of the publisher of this annotation (if any).
Optional count
An optional count, only relevant to certain aggregation types, see aggregation types documentation for more info.
Optional data
An arbitrary publisher-provided payload, if provided. Not aggregated.
Optional encoding
The encoding of the payload; typically empty as the data is decoded client-side back into the original data type.
A JSON object for metadata and/or ancillary payloads.
Unique ID assigned by Ably to this annotation.
The serial of the message (of type message.create) that this annotation is annotating.
Optional name
The name of this annotation. This is the field that most annotation aggregations will operate on. For example, using "distinct.v1" aggregation (specified in the type), the message summary will show a list of clients who have published an annotation with each distinct annotation.name.
This message's unique serial (lexicographically totally ordered).
Timestamp of when the annotation was received by Ably, as milliseconds since the Unix epoch.
The type of annotation it is, typically some name together with an aggregation method; for example: "emoji:distinct.v1". Handled opaquely by the SDK and validated serverside.
Generated using TypeDoc
An annotation to a message, received from Ably