Data Models
Comment
Comment Class
| 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. |
editedAt | any | Yes | Timestamp of when this comment was edited. Auto generated. |
createdAt | any | Yes | Timestamp of when this comment was created. Auto generated. |
isEdited | boolean | Yes | Whether the comment has been edited. 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. |
taggedUserContacts | AutocompleteUserContactReplaceData[] | No | List of users that were @mentioned in this comment. This contains addition metadata that is used to display the @mention in the UI. |
customList | AutocompleteReplaceData[] | No | List of custom list items added to the comment. |
isDraft | boolean | No | Whether the comment is in draft state. |
AutocompleteUserContactReplaceData Class
| Property | Type | Optional | Description |
|---|---|---|---|
text | string | No | The text displayed in the comment that represents the tagged user. |
userId | string | No | The user ID of the tagged user. |
contact | User | Yes | The user object of the tagged user. |
AutocompleteReplaceData Class
| Property | Type | Optional | Description |
|---|---|---|---|
text | string | No | The text displayed in the comment that represents the custom item. |
custom | AutocompleteItem | No | The custom item object associated with this text. |
AutocompleteItem Class Properties
| Property | Type | Optional | Description |
|---|---|---|---|
id | string | No | Unique identifier for the autocomplete item. |
name | string | No | Name or label of the autocomplete item. |
description | string | Yes | Additional description of the autocomplete item. |
icon | { url?: string, svg?: string } | Yes | Icon associated with the autocomplete item. Can be a URL or SVG string. |
link | string | Yes | Optional link associated with the autocomplete item. |
AutocompleteData Class
| Property | Type | Optional | Description |
|---|---|---|---|
hotkey | string | No | The hotkey or trigger for this autocomplete data. |
description | string | Yes | Optional description of the autocomplete data. |
type | ’custom’ | ‘contact’ | ‘group’ | No | The type of autocomplete data. Default is ‘custom’. |
data | AutocompleteItem[] | No | An array of AutocompleteItem objects containing the actual autocomplete data. |
Attachment Class
| Property | Type | Optional | Description |
|---|---|---|---|
attachmentId | number | No | Unique identifier for the attachment. Auto-generated. |
name | string | Yes | File name of the attachment. |
size | number | Yes | File size of the attachment. |
type | string | Yes | File type of the attachment. |
url | string | Yes | Download URL of the attachment. |
thumbnail | string | Yes | Thumbnail image in base64 format. |
thumbnailWithPlayIconUrl | string | Yes | URL of the thumbnail with a play icon overlay. |
metadata | any | Yes | Additional metadata of the attachment. |
mimeType | any | Yes | MIME type of the attachment. |
Was this page helpful?