Annotation | @coaty/core

Represents an annotation

Hierarchy

CoatyObject
- Annotation

Index

Properties

coreType

coreType: "Annotation"

The framework core type of the object, i.e. the name of the interface that defines the object's shape.

creationTimestamp

creationTimestamp: number

Timestamp when annotation was issued/created. Value represents the number of milliseconds since the epoc in UTC. (see Date.getTime(), Date.now())

creatorId

creatorId: string

UUID of User who created the annotation

Optional externalId

externalId?: string

External ID associated with this object (optional)

Optional isDeactivated

isDeactivated?: boolean

Marks an object that is no longer in use. The concrete definition meaning of this property is defined by the application. The property value is optional and should default to false.

Optional locationId

locationId?: string

Unique ID of Location object that this object has been associated with (optional).

name

name: string

The name/description of the object

objectId

objectId: string

Unique ID of the object

objectType

objectType: string

The concrete type name of the object.

The name should be in a canonical form following the naming convention for Java packages to avoid name collisions. All framework core types use the form coaty.<InterfaceName>, e.g. coaty.CoatyObject (see constants in CoreTypes class).

remarks: Object type names should be made up of characters in the range 0 to 9, a to z, A to Z, and dot (.).
remarks: All object types starting with coaty. are reserved for use by the Coaty framework and must not be used by applications to define custom object types.

Optional parentObjectId

parentObjectId?: string

Unique ID of parent/superordinate object (optional)

status

status: AnnotationStatus

Status of storage

type

type: AnnotationType

Specific type of this annotation object

Optional variants

variants?: AnnotationVariant[]

Array of annotation media variants (optional). A variant is an object with a description key and a download url