Class: EmbeddedFile

PSPDFKit.EmbeddedFile

This record is used to persist the information for an embedded file.

Extends

  • Immutable.Record

Members



Members

attachmentId: string

A unique identifier that can be used to fetch the contents of the file.

const embeddedFiles = await instance.getEmbeddedFiles()

const file = await instance.getAttachment(embeddedFiles.get(0).attachmentId)
Type:
  • string

(nullable) description: string

The description of the file if present.

Type:
  • string
Default Value:
  • null

(nullable) fileName: string

The name of the file with extension.

Type:
  • string
Default Value:
  • null

(nullable) fileSize: number

Size of the file in bytes.

Type:
  • number
Default Value:
  • null

(nullable) updatedAt: Date

The date on which the embedded file was updated.

Type:
  • Date
Default Value:
  • null

See also