feedback

Author: yoen-velt

async-collaboration/comments/customize-behavior.mdx

@@ -1090,57 +1090,77 @@ subscription?.unsubscribe()
 
 #### markAsRead
 
-Mark a comment annotation as read for the current user. This updates the `viewedBy` field of the comment annotation to include the current user.
+- Mark a comment annotation as read for the current user. This updates the `viewedBy` field of the comment annotation to include the current user.
+- Params: `annotationId: string`
+- Returns: `Promise<void>`
 
 <Tabs>
 <Tab title="React / Next.js">
 
 ```jsx
-// Using Hook
+const markAsReadRequest = {
+  annotationId: 'ANNOTATION_ID'
+};
+
+// Hook
 const { markAsRead } = useCommentUtils();
-await markAsRead('ANNOTATION_ID');
+await markAsRead(markAsReadRequest);
 
-// Using API Method
+// API Method
 const commentElement = client.getCommentElement();
-await commentElement.markAsRead('ANNOTATION_ID');
+await commentElement.markAsRead(markAsReadRequest);
 ```
 
 </Tab>
 
 <Tab title="Other Frameworks">
 
 ```js
+const markAsReadRequest = {
+  annotationId: 'ANNOTATION_ID'
+};
+
 const commentElement = Velt.getCommentElement();
-await commentElement.markAsRead('ANNOTATION_ID');
+await commentElement.markAsRead(markAsReadRequest);
 ```
 
 </Tab>
 </Tabs>
 
 #### markAsUnread
 
-Mark a comment annotation as unread for the current user. This removes the current user from the `viewedBy` field of the comment annotation.
+- Mark a comment annotation as unread for the current user. This removes the current user from the `viewedBy` field of the comment annotation.
+- Params: `annotationId: string`
+- Returns: `Promise<void>`
 
 <Tabs>
 <Tab title="React / Next.js">
 
 ```jsx
-// Using Hook
+const markAsUnreadRequest = {
+  annotationId: 'ANNOTATION_ID'
+};
+
+// Hook
 const { markAsUnread } = useCommentUtils();
-await markAsUnread('ANNOTATION_ID');
+await markAsUnread(markAsUnreadRequest);
 
-// Using API Method
+// API Method
 const commentElement = client.getCommentElement();
-await commentElement.markAsUnread('ANNOTATION_ID');
+await commentElement.markAsUnread(markAsUnreadRequest);
 ```
 
 </Tab>
 
 <Tab title="Other Frameworks">
 
 ```js
+const markAsUnreadRequest = {
+  annotationId: 'ANNOTATION_ID'
+};
+
 const commentElement = Velt.getCommentElement();
-await commentElement.markAsUnread('ANNOTATION_ID');
+await commentElement.markAsUnread(markAsUnreadRequest);
 ```
 
 </Tab>

release-notes/version-4/sdk-changelog.mdx

@@ -50,19 +50,23 @@ commentElement.markAsRead("eUgq6G6zXxJmOT9eBXtT");
 
 - [**Comments**]: You can now tag users by copy-pasting their email address. Previously, only manually typed emails worked for tagging users not on the contact list.
 
-- [**Comments**]: Added `viewedBy` and `reactionAnnotations` fields to the client annotation object. You can now access read/unread status and reaction data for comment annotations.
+- [**Comments**]: Added `viewedBy` and `reactionAnnotations` fields to comment annotation objects returned via REST APIs including [Get Comment Annotations](/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-v2) and [Get Comments](/api-reference/rest-apis/v2/comments-feature/comments/get-comments). These fields provide enhanced visibility into user engagement and reactions.
+
+**`viewedBy`**: An array of User objects representing who has seen and read the comment annotation. Use this to track engagement, identify which stakeholders have reviewed feedback, or build custom read receipt indicators.
+
+**`reactionAnnotations`**: An array of complete ReactionAnnotation objects containing the full reaction data for each comment. Each object includes the reaction ID, icon, user information, and metadata. Use this to display reaction counts, show who reacted with what emoji, or build custom reaction analytics.
 
 ```typescript
-// Annotation
+// Comment Annotation Object
 {
     ...
     comments: [
         {
             ...
-            reactionAnnotations?: ReactionAnnotation[];
+            reactionAnnotations?: ReactionAnnotation[]; // Complete reaction objects with full details
         }
     ],
-    viewedBy?: User[];
+    viewedBy?: User[]; // Users who have seen and read this annotation
 }
 ```
 
@@ -77,13 +81,7 @@ commentElement.markAsRead("eUgq6G6zXxJmOT9eBXtT");
 
 ### Improvements
 
-- [**Comments**]: Improved comment anchoring with a new fallback mechanism. Pin, text, and area comments now use enhanced element detection for more accurate positioning on dynamic websites.
-
-### Bug Fixes
-
-- [**Comments**]: Fixed an issue where the comment cursor was not displaying correctly on SquareSpace websites. The cursor now appears properly based on DOM element visibility.
-
-- [**Comments**]: Fixed an issue with comment positioning on image tags in SquareSpace websites. Container elements with static positioning are now conditionally set to relative positioning to ensure correct comment placement.
+- [**Comments**]: Released v2 improved version of comment anchoring that makes comment positioning more dynamic and robust on more dynamic websites. This includes enhanced element detection for pin, text, and area comments, improved cursor display based on DOM element visibility, and better handling of image tag positioning with conditional relative positioning for container elements.
 
 </Update>
 
@@ -94,7 +92,7 @@ commentElement.markAsRead("eUgq6G6zXxJmOT9eBXtT");
 
 - [**Comments**]: Fixed an issue where draft comments with resolvers were incorrectly submitted before being finalized, causing data inconsistencies. Draft comments with resolvers now work properly and are only saved when explicitly published.
 
-- [**Access Control**]: Fixed an issue where organization access permissions were not being set correctly during user identification. When users logged in, their organization-level permissions were failing to initialize properly. Organization access now gets assigned correctly during the identification process.
+- [**Access Control**]: Fixed an issue where organization access permissions were not being set correctly when using the permission provider. When users logged in, their organization-level permissions were failing to initialize properly. Organization access now gets assigned correctly during the identification process.
 
 </Update>