Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileAttachmentData

Hierarchy

  • FileAttachmentData

Index

Constructors

Properties

Constructors

constructor

  • new FileAttachmentData(config: { file: Uint8Array | Buffer | ArrayBuffer; fileName: string; fileType: string; itemId: string; label: string }): FileAttachmentData
  • Parameters

    • config: { file: Uint8Array | Buffer | ArrayBuffer; fileName: string; fileType: string; itemId: string; label: string }
      • file: Uint8Array | Buffer | ArrayBuffer

        The file to attach

      • fileName: string

        Name to be used for the file

      • fileType: string

        MIME type of the file

      • itemId: string

        Id of the item to add the attachment to

      • label: string

        Label of the slot that the attachment will be added to

    Returns FileAttachmentData

Properties

Readonly file

file: Uint8Array | Buffer | ArrayBuffer

The file to attach

Readonly fileName

fileName: string

Name to be used for the file

Readonly fileType

fileType: string

MIME type of the file

Readonly itemId

itemId: string

Id of the item to add the attachment to

Readonly label

label: string

Label of the slot that the attachment will be added to

Generated using TypeDoc