Models
CommentAnnotation
CommentAnnotation
Class Properties
Property | Type | Optional | Description |
---|---|---|---|
annotationId | string | No | Unique identifier for the comment pin annotation. Auto generated. |
comments | Comment[] | No | The list of all comments part of this annotation. |
commentCategories | CustomCategory[] | No | The list of categories that this comment pin annotation belongs to. |
from | User | No | The user who created this comment pin annotation. |
color | string | Yes | Color used for the comment pin annotation. |
resolved | boolean | Yes | Whether the comment annotation is marked resolved. Deprecated. |
inProgress | boolean | Yes | Whether the comment annotation is marked as in progress. Deprecated. |
lastUpdated | any | Yes | Timestamp when the comment annotation was last updated. Auto generated. |
position | CursorPosition | null | Yes | Cursor position relative to the comment annotation. |
locationId | number | null | Yes | Unique location id generated from provided location. |
location | Location | null | Yes | Set location to identify user on sub document. |
type | string | Yes | Type of the comment annotation. |
selectAllContent | boolean | Yes | If true, sets text comment annotation on all the text content. |
approved | boolean | Yes | Whether the comment annotation is approved. |
status | CustomStatus | No | Status of the comment annotation. |
annotationIndex | number | Yes | Index of current annotation in the list. |
pageInfo | PageInfo | Yes | Page information related to the comment annotation. |
assignedTo | User | Yes | User to whom the comment annotation is assigned. |
priority | CustomPriority | Yes | Priority level of the comment annotation. |
ghostComment | GhostComment | null | Yes | Placeholder for a non-existing comment. |
areaAnnotationId | string | Yes | Connected area annotation id. |
context | any | Yes | Custom context data provided by the user. |
resolvedByUserId | string | Yes | ID of the user who resolved the comment. |
Was this page helpful?