Interface IAnnotation

interface IAnnotation {
    annotationTemplateId?: null | string;
    createdAt?: string;
    deviceId?: string;
    editedAt?: string;
    endTime?: null | string;
    eventTriggerId?: null | string;
    id?: string;
    message: string;
    metadata?: IDictionary<string>;
    note?: null | string;
    notificationEnabled?: boolean;
    organizationId?: string;
    parentId?: null | string;
    publishedTo?: ISpreadsheetIdRange;
    setsDeviceColor?: boolean;
    streamName?: string;
    streamType?: keyof IStreamTypeMap;
    taggedUsers?: null | ITaggedUsers;
    tags: ITags;
    time: string;
    type: "annotation";
    updatedAt?: string;
    userId: string;
    viewed?: boolean;
}

Hierarchy (view full)

Properties

annotationTemplateId? createdAt? deviceId? editedAt? endTime? eventTriggerId? id? message metadata? note? notificationEnabled? organizationId? parentId? publishedTo? setsDeviceColor? streamName? streamType? taggedUsers? tags time type updatedAt? userId viewed?

Properties

Optional annotationTemplateId

annotationTemplateId?: null | string

Optional createdAt

createdAt?: string

Optional deviceId

deviceId?: string

Optional editedAt

editedAt?: string

Optional endTime

endTime?: null | string

Optional eventTriggerId

eventTriggerId?: null | string

Optional id

id?: string

message

message: string

Optional metadata

metadata?: IDictionary<string>

Optional note

note?: null | string

Optional notificationEnabled

notificationEnabled?: boolean

Optional organizationId

organizationId?: string

Optional parentId

parentId?: null | string

Optional publishedTo

publishedTo?: ISpreadsheetIdRange

Optional setsDeviceColor

setsDeviceColor?: boolean

Optional streamName

streamName?: string

Optional streamType

streamType?: keyof IStreamTypeMap

Optional taggedUsers

taggedUsers?: null | ITaggedUsers

tags

tags: ITags

time

time: string

type

type: "annotation"

Optional updatedAt

updatedAt?: string

userId

userId: string

Optional viewed

viewed?: boolean

Settings

Member Visibility

Theme

On This Page

annotationTemplateIdcreatedAtdeviceIdeditedAtendTimeeventTriggerIdidmessagemetadatanotenotificationEnabledorganizationIdparentIdpublishedTosetsDeviceColorstreamNamestreamTypetaggedUserstagstimetypeupdatedAtuserIdviewed

Generated using TypeDoc