Download item as used by download manager (accessible via app.downloader methods)

DownloadItem

Hierarchy (view full)

Constructors

Properties

addToLib: boolean

Whether the download item should be added to database after the download

album: string

album of the download item

artist: string

Artist of the download item

asJSON: string

Gets the object as serialized JSON string. Or sets serialized JSON (to fill this object's metadata by the metadata included within the JSON)

bytesDownloaded: number

How many bytes has been already downloaded

bytesTotal: number

Total size in bytes

completed: boolean

Whether the download item is completed

destination: string

Destination file path (where the data is being downloaded)

dontShowErrors: boolean

Do not show download errors for this item

genre: string

genre of the download item

id: number

Gets integer id of the object

objectType: string

Gets the object type as string

pauseIsPossible: boolean

Whether pause is possible for this item

persistentID: string

Gets persistent id of the object

queued: boolean

Whether the download item is paused (queued)

requestBody: string

Request body (in case of HTTP POST method)

source: string

URL of the download item

statusInfo: Promise<any>

Undocumented

targetMask: string

Undocumented

title: string

title of the download item

track: Track

Undocumented

transferRateKBs: number

Current transfer rate in KB//s

Methods

  • Parameters

    Returns Promise<any>

    Undocumented

  • Gets class name of the object.

    Returns string

  • Parameters

    • id: number

    Returns boolean

    Undocumented

  • Call defined method with locked data so user can access them.

    Parameters

    • func: (() => any)

      Method to call

        • (): any
        • Returns any

    Returns void

  • Parameters

    • id: number
    • value: boolean

    Returns void

    Undocumented