Class AttachmentAnnotation

A file attached to a page. The attached file's bytes are retrieved through the attachment-content endpoint, not in the annotation response.

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

_discriminator accessType? attachmentLength? comment? createdTime? creator? customData? entryId? fileName? isProtected? isReadOnly? itemId? lastModifiedTime? mimeType? pageNumber? position? reasonId? visibility? zOrder?

Methods

init toJSON fromJS

Constructors

constructor

Properties

Protected_discriminator

_discriminator: string

OptionalaccessType

accessType?: AnnotationAccessControlType

How the annotation participates in access control.

OptionalattachmentLength

attachmentLength?: number

The size of the attached file in bytes.

Optionalcomment

comment?: string

An optional comment on the annotation.

OptionalcreatedTime

createdTime?: Date

The UTC time the annotation was created.

Optionalcreator

creator?: string

The security identifier (SID) of the user that created the annotation.

OptionalcustomData

customData?: string

Optional application-defined custom data stored with the annotation.

OptionalentryId

entryId?: number

The ID of the document entry the annotation belongs to.

OptionalfileName

fileName?: string

The original file name of the attachment.

OptionalisProtected

isProtected?: boolean

A boolean indicating whether the annotation is protected so that only its creator can modify it.

OptionalisReadOnly

isReadOnly?: boolean

A boolean indicating whether the annotation is read-only (for example, on an archived version).

OptionalitemId

itemId?: number

The identifier of the annotation, unique within its page.

OptionallastModifiedTime

lastModifiedTime?: Date

The UTC time the annotation was last modified.

OptionalmimeType

mimeType?: string

The MIME type of the attached file.

OptionalpageNumber

pageNumber?: number

The 1-based page number the annotation is on.

Optionalposition

position?: AnnotationPoint

The top-left position of the attachment icon on the page.

OptionalreasonId

reasonId?: number

The ID of the redaction reason associated with the annotation, if any.

Optionalvisibility

visibility?: AnnotationVisibility

Controls who can see the annotation.

OptionalzOrder

zOrder?: number

The z-order of the annotation; higher values draw on top.

Methods

init

toJSON

StaticfromJS

Settings

Member Visibility

On This Page

Constructors
Properties
Methods