Skip to content

Commit a636e17

Browse files
mschristensenSimonWoolf
authored andcommitted
Add annotations docs
1 parent 504be28 commit a636e17

File tree

9 files changed

+520
-0
lines changed

9 files changed

+520
-0
lines changed

content/partials/core-features/_authentication_capabilities.textile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ The following capability operations are available for API keys and issued tokens
55
- presence := can register presence on a channel (enter, update and leave)
66
- object-subscribe := can subscribe to updates to objects on a channel
77
- object-publish := can update objects on a channel
8+
- annotation-subscribe := can subscribe to individual annotations on a channel
9+
- annotation-publish := can publish annotations to messages on a channel
810
- history := can retrieve message and presence state history on channels
911
- stats := can retrieve current and historical usage statistics for an app
1012
- push-subscribe := can subscribe devices for push notifications

src/data/nav/pubsub.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,10 @@ export default {
195195
name: 'Message batching',
196196
link: '/docs/messages/batch',
197197
},
198+
{
199+
name: 'Message annotations',
200+
link: '/docs/messages/annotations',
201+
},
198202
],
199203
},
200204
{

src/pages/docs/auth/capabilities.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ The following capability operations are available for API keys and issued tokens
4040
| **presence** | Can register presence on a channel (enter, update and leave) |
4141
| **object-subscribe** | Can subscribe to updates to objects on a channel |
4242
| **object-publish** | Can update objects on a channel |
43+
| **annotation-subscribe** | Can subscribe to individual annotations on a channel |
44+
| **annotation-publish** | Can publish annotations to messages on a channel |
4345
| **history** | Can retrieve message and presence state history on channels |
4446
| **stats** | Can retrieve current and historical usage statistics for an app |
4547
| **push-subscribe** | Can subscribe devices for push notifications |

src/pages/docs/channels/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@ The channel rules related to enabling features are:
200200
| Push notifications enabled | If checked, publishing messages with a push payload in the `extras` field is permitted. This triggers the delivery of a [Push Notification](/docs/push) to devices registered for push on the channel. |
201201
| Server-side batching | If enabled, messages are grouped into batches before being sent to subscribers. [Server-side batching](/docs/messages/batch#server-side) reduces the overall message count, lowers costs, and mitigates the risk of hitting rate limits during high-throughput scenarios. |
202202
| Message conflation | If enabled, messages are aggregated over a set period of time and evaluated against a conflation key. All but the latest message for each conflation key value will be discarded, and the resulting message, or messages, will be delivered to subscribers as a single batch once the period of time elapses. [Message conflation](/docs/messages#conflation) reduces costs in high-throughput scenarios by removing redundant and outdated messages. |
203+
| Message annotations, updates, and deletes | If enabled, allows message "annotations":/docs/annotations to be used, as well as updates and deletes to be published to messages. Note that these features are currently Experimental and its features are still in development and subject to change. When this feature is enabled, messages will be "persisted":/docs/storage-history/storage#all-message-persistence (necessary in order from them later be annotated or updated), and "continuous history":/docs/storage-history/history#continuous-history features will unfortunately not work (yet).
203204

204205
To set a channel rule in the Ably dashboard:
205206

src/pages/docs/channels/options/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,8 @@ The available set of channel mode flags are:
438438
| `PRESENCE` | Can register presence on the channel. | Yes |
439439
| `OBJECT_PUBLISH` | Can update objects on the channel. | No |
440440
| `OBJECT_SUBSCRIBE` | Can subscribe to receive updates to objects on the channel. | No |
441+
| `ANNOTATION_PUBLISH` | Can publish annotations to messages on the channel. | Yes |
442+
| `ANNOTATION_SUBSCRIBE` | Can subscribe to individual annotations on the channel. | No |
441443

442444
The set of modes available to a client is determined by the set of [capabilities](/docs/auth/capabilities) granted by their token or API key.
443445

@@ -450,6 +452,8 @@ The modes granted by each capability are:
450452
| `presence` | `PRESENCE` |
451453
| `object-subscribe` | `OBJECT_SUBSCRIBE` |
452454
| `object-publish` | `OBJECT_PUBLISH` |
455+
| `annotation-publish` | `ANNOTATION_PUBLISH` |
456+
| `annotation-subscribe` | `ANNOTATION_SUBSCRIBE` |
453457

454458
The actual modes assigned to a client will be the **intersection** of the requested `modes` and the modes available to the client according to its capabilities. For example, a client with the `subscribe` capability which explicitly requests `SUBSCRIBE` and `PUBLISH` modes will be assigned only the `SUBSCRIBE` mode.
455459

0 commit comments

Comments
 (0)