Options
All
  • Public
  • Public/Protected
  • All
Menu

FileApi provides operations used to import, export, and migrate content.

Hierarchy

  • FileApi

Index

Methods

convertLibrary

  • convertLibrary(extract: boolean): Promise<void>
  • Converts a library file or directory.

    Parameters

    • extract: boolean

      true if the file should be extracted or false if the directory packaged.

    Returns Promise<void>

convertStorage

  • convertStorage(extract: boolean, overwrite: boolean): Promise<void>
  • Converts and indexed storage file or directory.

    Parameters

    • extract: boolean

      true if the file should be extracted or false if the directory packaged.

    • overwrite: boolean

      true to overwrite existing files.

    Returns Promise<void>

copyDataSpace

  • copyDataSpace(download: boolean, overwrite: boolean): Promise<void>
  • Uploads the local file system data space to the database data space or downloads the database data space to the local file system data space.

    Parameters

    • download: boolean

      true to download the database the file system; false to upload the file system to the database.

    • overwrite: boolean

      true to overwrite existing files; false to retain existing files.

    Returns Promise<void>

exportAssets

  • exportAssets(name: string, includes: string[], excludes: string[]): Promise<ArrayBuffer>
  • Exports assets from the repository.

    Parameters

    • name: string

      the name of the exported ZIP file.

    • includes: string[]

      the list of patterns matching assets to include.

    • excludes: string[]

      the list of patterns matching assets to exclude.

    Returns Promise<ArrayBuffer>

    the binary content of asset ZIP file.

importAssets

  • importAssets(data: ArrayBuffer, excluded: string[], overwrite: boolean): Promise<void>
  • Imports assets into the repository.

    Parameters

    • data: ArrayBuffer

      the binary content of asset ZIP file.

    • excluded: string[]

      the identifiers of the assets to be excluded from the import.

    • overwrite: boolean

      true to overwrite existing assets.

    Returns Promise<void>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc