Share via


DocumentAnnotation interface

Annotation in a document, such as a strikethrough or a comment.

Properties

author

Annotation author.

comments

Comments associated with the annotation.

createdAt

Date and time when the annotation was created.

id

Annotation identifier.

kind

Annotation kind.

lastModifiedAt

Date and time when the annotation was last modified.

source

Position of the annotation.

spans

Spans of the content associated with the annotation.

tags

Tags associated with the annotation.

Property Details

author

Annotation author.

author?: string

Property Value

string

comments

Comments associated with the annotation.

comments?: DocumentAnnotationComment[]

Property Value

createdAt

Date and time when the annotation was created.

createdAt?: Date

Property Value

Date

id

Annotation identifier.

id: string

Property Value

string

kind

Annotation kind.

kind: DocumentAnnotationKind

Property Value

lastModifiedAt

Date and time when the annotation was last modified.

lastModifiedAt?: Date

Property Value

Date

source

Position of the annotation.

source?: string

Property Value

string

spans

Spans of the content associated with the annotation.

spans?: ContentSpan[]

Property Value

tags

Tags associated with the annotation.

tags?: string[]

Property Value

string[]