Update ably.d.ts

SimonWoolf · AndyTWF · web-flow · commit b6f6900c936d · 2025-03-31T18:17:02.000+01:00
Co-authored-by: Andy Ford &lt;andy.ford@ably.com&gt;
diff --git a/ably.d.ts b/ably.d.ts
@@ -2048,7 +2048,7 @@ export declare interface RealtimePresence {
  */
 export declare interface RealtimeAnnotations {
   /**
-   * Registers a listener that is called each time an {@link Annotation} matching a given refType.
+   * Registers a listener that is called each time an {@link Annotation} matching a given refType is received on the channel.
    * Note that if you want to receive individual realtime annotations (instead of just the rolled-up summaries), you will need to request the annotation_subscribe ChannelMode in ChannelOptions, since they are not delivered by default. In general, most clients will not bother with subscribing to individual annotations, and will instead just look at the summary updates.
    *
    * @param refType - A specific refType string or an array of them to register the listener for.

Original file line number	Diff line number	Diff line change
`@@ -2048,7 +2048,7 @@ export declare interface RealtimePresence {`
`2048`	`2048`	`*/`
`2049`	`2049`	`export declare interface RealtimeAnnotations {`
`2050`	`2050`	`/**`
`2051`		`- * Registers a listener that is called each time an {@link Annotation} matching a given refType.`
	`2051`	`+ * Registers a listener that is called each time an {@link Annotation} matching a given refType is received on the channel.`
`2052`	`2052`	`* Note that if you want to receive individual realtime annotations (instead of just the rolled-up summaries), you will need to request the annotation_subscribe ChannelMode in ChannelOptions, since they are not delivered by default. In general, most clients will not bother with subscribing to individual annotations, and will instead just look at the summary updates.`
`2053`	`2053`	`*`
`2054`	`2054`	`* @param refType - A specific refType string or an array of them to register the listener for.`