You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/messages/annotations.mdx
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -34,17 +34,17 @@ Annotations are a special type of message with the following properties:
34
34
35
35
| Property | Description |
36
36
| -------- | ----------- |
37
-
| id | An Ably-generated ID used to uniquely identify the message. |
37
+
| id | An Ably-generated ID used to uniquely identify the annotation. |
38
38
| action | The action specifies whether this is an annotation being added (`annotation.create`) or removed (`annotation.delete`). See [subscribing to annotation updates](#subscribe). |
39
-
| serial | This message's unique serial (lexicographically totally ordered). |
39
+
| serial | This annotation's unique serial (lexicographically totally ordered). |
40
40
| messageSerial | The serial of the message that this annotation is annotating. |
41
41
| type | The [annotation type](#annotation-types). |
42
42
| name | The name of the annotation, used by some summarization methods for aggregation. See [annotation summaries](#annotation-summaries). |
43
43
| clientId | The client identifier of the user that published this annotation. |
44
44
| count | An optional count, only relevant to certain summarization methods. See [annotation summaries](#annotation-summaries) for more information. |
45
45
| data | An optional payload for the annotation. Available on an [individual annotation](#subscribe-individual-annotations) but not aggregated or included in [annotation summaries](#annotation-summaries). |
46
-
| encoding | This is typically empty, as all messages received from Ably are automatically decoded client-side using this value. However, if the message encoding cannot be processed, this attribute contains the remaining transformations not applied to the `data` payload. |
47
-
| timestamp | The timestamp of when the message was received by Ably, as milliseconds since the Unix epoch. |
46
+
| encoding | This is typically empty, as all annotations received from Ably are automatically decoded client-side using this value. However, if the annotation encoding cannot be processed, this attribute contains the remaining transformations not applied to the `data` payload. |
47
+
| timestamp | The timestamp of when the annotation was received by Ably, as milliseconds since the Unix epoch. |
0 commit comments