Skip to content

Commit 75b0e3d

Browse files
committed
annotations: (un)identified client clarifications
Specifies which summarization methods unidentified clients may use. Describes how to require that all clients are identified via the Identified channel rule.
1 parent 892c681 commit 75b0e3d

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

src/pages/docs/messages/annotations.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,12 @@ If the same client publishes an annotation of a given type to the same message t
295295
}
296296
```
297297

298+
<Aside data-type="note">
299+
[Unidentified](/docs/auth/identified-clients#unidentified) clients can publish `total.v1` annotations.
300+
301+
You can use the Identified [channel rule](/docs/channels#rules) to prevent unidentified clients from publishing annotations.
302+
</Aside>
303+
298304

299305
### Flag
300306

@@ -314,7 +320,7 @@ A given client can contribute to the summary only once per [annotation type](#an
314320
```
315321

316322
<Aside data-type="note">
317-
You must specify a `clientId`in the [client options](/docs/api/realtime-sdk#client-options) to publish `flag.v1` annotations.
323+
Clients must be [identified](/docs/auth/identified-clients) to publish `flag.v1` annotations.
318324
</Aside>
319325

320326

@@ -342,7 +348,7 @@ A given client can contribute to the summary for a particular annotation `name`
342348
[Deleting](#delete) an annotation removes the `clientId` from the list of clients that contributed to the summary for that `name`, and decrements the total count for that `name`.
343349

344350
<Aside data-type="note">
345-
You must specify a `clientId`in the [client options](/docs/api/realtime-sdk#client-options) to publish `distinct.v1` annotations.
351+
Clients must be [identified](/docs/auth/identified-clients) to publish `distinct.v1` annotations.
346352
</Aside>
347353

348354
### Unique
@@ -369,7 +375,7 @@ A given client can contribute to the summary for a particular annotation `name`
369375
[Deleting](#delete) an annotation removes the `clientId` from the list of clients that contributed to the summary for that `name`, and decrements the total count for that `name`.
370376

371377
<Aside data-type="note">
372-
You must specify a `clientId`in the [client options](/docs/api/realtime-sdk#client-options) to publish `unique.v1` annotations.
378+
Clients must be [identified](/docs/auth/identified-clients) to publish `unique.v1` annotations.
373379
</Aside>
374380

375381
### Multiple
@@ -404,3 +410,9 @@ If a client specifies a `count` when publishing an annotation, the client's cont
404410
```
405411

406412
[Deleting](#delete) an annotation removes all contributions made by that `clientId` for that `name`.
413+
414+
<Aside data-type="note">
415+
[Unidentified](/docs/auth/identified-clients#unidentified) clients can publish `multiple.v1` annotations.
416+
417+
You can use the Identified [channel rule](/docs/channels#rules) to prevent unidentified clients from publishing annotations.
418+
</Aside>

0 commit comments

Comments
 (0)