Skip to content

Latest commit

 

History

History
168 lines (105 loc) · 5.31 KB

cloudFile.rst

File metadata and controls

168 lines (105 loc) · 5.31 KB

cloudFile

The cloudFile (a.k.a. fileLink) API first appeared in Thunderbird 64, and was uplifted to Thunderbird 60.4 ESR.

Currently extensions using this API can have one account per provider (thus one per extension) but it is designed for a future upgrade where multiple accounts per provider are possible.

The DropBox Uploader sample extension uses this API.

Manifest file properties

  • [cloud_file] (object)
    • management_url (string) A page for configuring accounts, to be displayed in the preferences UI.
    • name (string) Name of the cloud file service.
    • [new_account_url] (string) Deprecated. This property was never used.
    • [service_url] (string) URL to the web page of the cloud file service.
    • [settings_url] (string) Deprecated. A page for configuring accounts, this is obsolete after Thunderbird 60.

Note

A manifest entry named cloud_file is required to use cloudFile.

Functions

getAccount(accountId)

Retrieve information about a single cloud file account

  • accountId (string) Unique identifier of the account

Returns a Promise fulfilled with:

getAllAccounts()

Retrieve all cloud file accounts for the current add-on

Returns a Promise fulfilled with:

updateAccount(accountId, updateProperties)

Update a cloud file account

  • accountId (string) Unique identifier of the account
  • updateProperties (object)
    • [configured] (boolean) If true, the account is configured and ready to use. This property is currently ignored and all accounts are assumed to be configured.
    • [managementUrl] (string) A page for configuring accounts, to be displayed in the preferences UI.
    • [settingsUrl] (string) Deprecated. A page for configuring accounts, this is obsolete after Thunderbird 60.
    • [spaceRemaining] (integer) The amount of remaining space on the cloud provider, in bytes. Set to -1 if unsupported.
    • [spaceUsed] (integer) The amount of space already used on the cloud provider, in bytes. Set to -1 if unsupported.
    • [uploadSizeLimit] (integer) The maximum size in bytes for a single file to upload. Set to -1 if unlimited.

Returns a Promise fulfilled with:

Events

onFileUpload(account, fileInfo)

Fired when a file should be uploaded to the cloud file provider

Event listeners should return:

  • object
    • [aborted] (boolean) Set this to true if the file upload was aborted
    • [url] (string) The URL where the uploaded file can be accessed

onFileUploadAbort(account, fileId)

onFileDeleted(account, fileId)

Fired when a file previously uploaded should be deleted

onAccountAdded(account)

Fired when a cloud file account of this add-on was created

onAccountDeleted(accountId)

Fired when a cloud file account of this add-on was deleted

  • accountId (string) The id of the removed account

Types

CloudFile

Information about a cloud file

object

  • data (ArrayBuffer) Contents of the file to be transferred
  • id (integer) An identifier for this file
  • name (string) Filename of the file to be transferred

CloudFileAccount

Information about a cloud file account

object

  • configured (boolean) If true, the account is configured and ready to use. This property is currently ignored and all accounts are assumed to be configured.
  • id (string) Unique identifier of the account
  • managementUrl (string) A page for configuring accounts, to be displayed in the preferences UI.
  • name (string) A user-friendly name for this account.
  • [settingsUrl] (string) Deprecated. A page for configuring accounts, this is obsolete after Thunderbird 60.
  • [spaceRemaining] (integer) The amount of remaining space on the cloud provider, in bytes. Set to -1 if unsupported.
  • [spaceUsed] (integer) The amount of space already used on the cloud provider, in bytes. Set to -1 if unsupported.
  • [uploadSizeLimit] (integer) The maximum size in bytes for a single file to upload. Set to -1 if unlimited.