The framework core type of the object, i.e. the name of the interface that defines the object's shape.
Timestamp when snapshot was issued/created. Value represents the number of milliseconds since the epoc in UTC (see Date.getTime(), Date.now()).
UUID of creator of this snapshot.
External ID associated with this object (optional)
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.
Unique ID of Location object that this object has been associated with (optional).
The name/description of the object
The Coaty object captured by this snapshot.
Unique ID of the object
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).
Unique ID of parent/superordinate object (optional)
Tags associated with this snapshot (optional). They can be used on retrieval to identify different purposes of the snapshot.
Generated using TypeDoc
Represents a snapshot in time of the state of any Coaty object. A snapshot is typically generated by an instance of the
HistorianController
class. The propertyparentObjectId
is inherited from the base CoatyObject type and needs to be set in a Snapshot. This is automatically validated by the framework.