External: FileTransfer

FileTransfer

The FileTransfer object is used to handle the copy of files. It is created by a call to external:FileManager#copy.
Source:

Members

<readonly> done :boolean

Tells whether a file transfer is finished.
Type:
  • boolean
Source:

<readonly> error :string

Get the error message when a file transfer has failed.
Type:
  • string
Source:

<readonly> receivedBytes :number

Get the number of bytes that have been received.
Type:
  • number
Source:

<readonly> sourceUrl :string

The URL of the source of the file transfer.
Type:
  • string
Source:

<readonly> targetUrl :string

The URL of the target of the file transfer.
Type:
  • string
Source:

<readonly> totalBytes :number

Get the total number of bytes of the file transfer.
Type:
  • number
Source:

Methods

cancel()

Cancel the file transfer
Source:

start()

Start the file transfer
Source: