Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "plugins"

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

BeforeDeleteFileCallback

BeforeDeleteFileCallback: function

A function / method that is called BEFORE a file is going to be deleted.

param

The custom destination to display.

Type declaration

    • (destination?: string): PromiseLike<void>

    • Parameters

      • Optional destination: string

      Returns PromiseLike<void>

BeforeDownloadFileCallback

BeforeDownloadFileCallback: function

A function / method that is called BEFORE a file is going to be downloaded.

param

The custom source to display.

Type declaration

    • (source?: string): PromiseLike<void>

    • Parameters

      • Optional source: string

      Returns PromiseLike<void>

BeforeRemoveFolderCallback

BeforeRemoveFolderCallback: function

A function / method that is called BEFORE a folder is going to be removed.

param

The custom destination to display.

Type declaration

    • (destination?: string): PromiseLike<void>

    • Parameters

      • Optional destination: string

      Returns PromiseLike<void>

BeforeUploadFileCallback

BeforeUploadFileCallback: function

A function / method that is called BEFORE a file is going to be uploaded.

param

The custom destination to display.

Type declaration

    • (destination?: string): PromiseLike<void>

    • Parameters

      • Optional destination: string

      Returns PromiseLike<void>

DeleteFileCompletedCallback

DeleteFileCompletedCallback: function

A function / method that is called AFTER a delete operation for a file has been finished.

param

The error (if occurred).

param

Tells the calling "client" that it should delete its local version or not.

Type declaration

    • (err?: any, deleteLocal?: boolean): PromiseLike<void>

    • Parameters

      • Optional err: any
      • Optional deleteLocal: boolean

      Returns PromiseLike<void>

DownloadFileCompletedCallback

DownloadFileCompletedCallback: function

A function / method that is called AFTER a download operation for a file has been finished.

param

The error (if occurred).

param

The downloaded file (if available).

Type declaration

    • (err: any, file?: DownloadedFile | Buffer | string | Stream.Stream): PromiseLike<void>

    • Parameters

      • err: any
      • Optional file: DownloadedFile | Buffer | string | Stream.Stream

      Returns PromiseLike<void>

InitializePluginResult

InitializePluginResult: boolean | void

The result for the 'initialize' method of a plugin.

NewPlugins

NewPlugins: Plugin | PromiseLike<Plugin> | Plugin[] | PromiseLike<Plugin[]>

Result type of new plugins.

PrepareBaseTargetResult

PrepareBaseTargetResult: TTarget | false

A result for preparing a base target.

PrepareTargetsResult

PrepareTargetsResult: Target | Target[] | false

A result for preparing targets.

RemoveFolderCompletedCallback

RemoveFolderCompletedCallback: function

A function / method that is called AFTER a delete operation for a folder has been finished.

param

The error (if occurred).

param

Tells the calling "client" that it should delete its local version or not.

Type declaration

    • (err?: any, deleteLocal?: boolean): PromiseLike<void>

    • Parameters

      • Optional err: any
      • Optional deleteLocal: boolean

      Returns PromiseLike<void>

UploadFileCompletedCallback

UploadFileCompletedCallback: function

A function / method that is called AFTER an upload operation for a file has been finished.

param

The error (if occurred).

Type declaration

    • (err?: any): PromiseLike<void>

    • Parameters

      • Optional err: any

      Returns PromiseLike<void>

Functions

canDelete

  • Checks if a plugin can delete files.

    Parameters

    Returns boolean

    Can delete or not.

canDo

  • canDo(plugin: Plugin, target: Target, canFlagResolver: function, methodResolver: function): boolean

canDownload

  • Checks if a plugin can download files.

    Parameters

    Returns boolean

    Can download or not.

canList

  • Checks if a plugin can list directories.

    Parameters

    Returns boolean

    Can list or not.

canRemoveFolders

  • Checks if a plugin can remove folders.

    Parameters

    Returns boolean

    Can remove folders or not.

canUpload

  • Checks if a plugin can upload files.

    Parameters

    Returns boolean

    Can upload or not.

createDownloadedFileFromBuffer

  • Creates a new instance of a 'downloaded file' from a buffer.

    Parameters

    • file: WorkspaceFile

      The underlying workspace file.

    • buff: Buffer

      The buffer with the data.

    Returns DownloadedFile

    The new object.

Generated using TypeDoc