Skip to content

Commit 28d43f4

Browse files
committed
fixup! annotations: publish, subscribe, summary and type
1 parent 75b0e3d commit 28d43f4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/pages/docs/messages/annotations.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ Annotations are a special type of message with the following properties:
3434

3535
| Property | Description |
3636
| -------- | ----------- |
37-
| id | An Ably-generated ID used to uniquely identify the message. |
37+
| id | An Ably-generated ID used to uniquely identify the annotation. |
3838
| 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). |
4040
| messageSerial | The serial of the message that this annotation is annotating. |
4141
| type | The [annotation type](#annotation-types). |
4242
| name | The name of the annotation, used by some summarization methods for aggregation. See [annotation summaries](#annotation-summaries). |
4343
| clientId | The client identifier of the user that published this annotation. |
4444
| count | An optional count, only relevant to certain summarization methods. See [annotation summaries](#annotation-summaries) for more information. |
4545
| 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. |
4848

4949

5050
## Publishing annotations <a id="publish" />

0 commit comments

Comments
 (0)