Annotation

open class Annotation : CoatyObject

Represents an annotation

Class registration.


                    
                    
                    objectType

Undocumented

Declaration

Swift

override open class var objectType: String { get }

Attributes.

type
Specific type of this annotation object
Declaration
Swift

public var type: AnnotationType
creatorId
UUID of User who created the annotation
Declaration
Swift

public var creatorId: CoatyUUID
creationTimestamp
Timestamp when annotation was issued/created. Value represents the number of milliseconds since the epoc in UTC. (see Date.getTime(), Date.now())
Declaration
Swift

public var creationTimestamp: Double
status
Status of storage
Declaration
Swift

public var status: AnnotationStatus
variants
Array of annotation media variants (optional). A variant is an object with a description key and a download url
Declaration
Swift

public var variants: [AnnotationVariant]?

Initializers.


                    
                    
                    init(type:creatorId:creationTimestamp:status:name:objectType:objectId:variants:)

Default initializer for a nAnnotation object.

Declaration

Swift

public init(type: AnnotationType,

            creatorId: CoatyUUID,

            creationTimestamp: Double,

            status: AnnotationStatus,

            name: String = "AnnotationObject",

            objectType: String = Annotation.objectType,

            objectId: CoatyUUID = .init(),

            variants: [AnnotationVariant]? = nil)

Codable methods.


                    
                    
                    init(from:)

Undocumented

Declaration

Swift

public required init(from decoder: Decoder) throws


                    
                    
                    encode(to:)

Undocumented

Declaration

Swift

open override func encode(to encoder: Encoder) throws