Models
Notification
Notification
Class Properties
Property | Type | Optional | Description |
---|---|---|---|
id | string | No | Notification ID |
notificationSource | string | Yes | Notification source |
notificationSourceData | any | Yes | The source data that caused the notification. Eg: CommentAnnotation |
actionType | string | Yes | Notification type |
isUnread | boolean | Yes | Notification is read or not for the user |
actionUser | User | Yes | Action user of the notification |
timestamp | number | Yes | Timestamp of the notification |
displayHeadlineMessage | string | Yes | Notification headline message |
displayBodyMessage | string | Yes | Notification body message |
forYou | boolean | Yes | Is notification for the current logged in user |
metadata | NotificationMetadata | Yes | Metadata for the current notification |
NotificationMetadata
Class Properties
Property | Type | Optional | Description |
---|---|---|---|
apiKey | string | Yes | The API key |
clientOrganizationId | string | Yes | The client orgnnization ID |
organizationId | string | Yes | The organization ID |
clientDocumentId | string | Yes | The client document ID |
documentId | string | Yes | The document ID |
locationId | number | Yes | The location ID |
location | location | Yes | The location object |
Was this page helpful?