Models
Comment
Comment Class Properties
| Property | Type | Optional | Description |
|---|---|---|---|
commentId | number | No | Unique identifier for the comment pin annotation. Auto generated. |
type | ‘text’ | ‘voice’ | No | This determines the comment content type. Default is ‘text’. |
commentText | string | No | The actual text content of the comment. |
commentHtml | string | Yes | Same comment text but formatted in HTML. |
replaceContentHtml | string | Yes | HTML content to replace the comment text when user accepts the comment. |
replaceContentText | string | Yes | Text content to replace the comment text when user accepts the comment. |
commentVoiceUrl | string | Yes | URL of the voice recording for the comment, if available. |
from | User | No | The user who created this comment. |
to | User[] | Yes | List of users that were @mentioned in this comment. |
lastUpdated | Date | Yes | Timestamp of when this comment was last updated. Auto generated. |
status | ‘added’ | ‘updated’ | No | Status of the comment indicating whether it was newly added or updated. |
attachments | Attachment[] | No | List of attachments associated with the comment. |
recorders | RecordedData[] | No | List of recorded data associated with the comment. |
reactionAnnotationIds | string[] | No | List of annotation IDs for reactions to the comment. |
ManualCommentAnnotationConfig Class Properties
| Property | Type | Optional | Description |
|---|---|---|---|
context | any | Yes | Custom context data provided by the user. |
Was this page helpful?