Class Downloader

Download manager class to handle pending/current downloads. Access via the global app.downloader.

Downloader

Hierarchy (view full)

SharedObservable
- Downloader

Constructors

constructor

new Downloader(): Downloader
Returns Downloader
Inherited from SharedObservable.constructor

Properties

asJSON

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)

deleted

deleted: boolean

Set to true after deletion so that 'change' event is called and item is removed from UI lists.

dontNotify

dontNotify: boolean

Undocumented

id

id: number

Gets integer id of the object

isObservable

isObservable: boolean

Whether this object can be listened (e.g. for 'change' event)

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

itemList

itemList: DownloadItemList

Gets all download items as list

Returns

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

statusInfo

statusInfo: Promise<any>

Undocumented

streamUrlRequests

streamUrlRequests: number

Undocumented

title

title: string

Gets the object title

Methods

anyDownloadExists

anyDownloadExists(fromDB): boolean
Parameters
- fromDB: boolean
Returns boolean
Undocumented
- Defined in src/types/Native.ts:7398

anyDownloadInProgress

anyDownloadInProgress(): boolean
Returns whether any download item is currently in download progress

Returns boolean
- Defined in src/types/Native.ts:7377

anyDownloadIsPaused

anyDownloadIsPaused(): boolean
Returns whether any download item is currently paused

Returns boolean
- Defined in src/types/Native.ts:7383

beginUpdate

beginUpdate(): void
Lock object to update state. Events are not called when in update state.

Returns void
Inherited from SharedObservable.beginUpdate
- Defined in src/types/Native.ts:276

cancelAllDownloads

cancelAllDownloads(): void
Cancels all downloads (include paused downloads)

Returns void
- Defined in src/types/Native.ts:7413

cancelDownload

cancelDownload(DI): void
Cancels download item
Parameters
- DI: DownloadItem
Returns void
- Defined in src/types/Native.ts:7363

cancelDownloads

cancelDownloads(list): void
Parameters
- list: SharedList<DownloadItem>
Returns void
Undocumented
- Defined in src/types/Native.ts:7364

checkDownloadsQueue

checkDownloadsQueue(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:7414

checkUpdate

checkUpdate(interval): void
Updates the object every X ms when called periodically. Useful e.g. when filling lists. Can be used only in the update lock! (i.e. between beginUpdate/endUpdate)
Parameters
- interval: number
Returns void
Inherited from SharedObservable.checkUpdate
- Defined in src/types/Native.ts:288

commit

commit(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:7415

commitAsync

commitAsync(): Promise<any>
Commits into database

Returns Promise<any>
- Defined in src/types/Native.ts:7420

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
Inherited from SharedObservable.doCut
- Defined in src/types/Native.ts:213

downloadFinished

downloadFinished(aDI, ResponseCode, error): void
Parameters
- aDI: DownloadItem
- ResponseCode: number
- error: string
Returns void
Undocumented
- Defined in src/types/Native.ts:7344

downloadTrack

downloadTrack(track, downloadMask, showErrors): void
Parameters
- track: Track
- downloadMask: string
- showErrors: boolean
Returns void
Undocumented
- Defined in src/types/Native.ts:7430

endUpdate

endUpdate(): boolean
Unlock object from update state. beginUpdate and endUpdate must be in pair. When endUpdate is called, change event is called.

Returns boolean
Inherited from SharedObservable.endUpdate
- Defined in src/types/Native.ts:282

getClassName

getClassName(): string
Gets class name of the object.

Returns string
Inherited from SharedObservable.getClassName
- Defined in src/types/Native.ts:198

getDownloadItem

getDownloadItem(URL): DownloadItem
Gets download item based on given URL
Parameters
- URL: string
Returns DownloadItem
- Defined in src/types/Native.ts:7390

getDownloadsCount

getDownloadsCount(): number
Gets downloads count (include paused downloads)

Returns number
- Defined in src/types/Native.ts:7396

getPersistentJSON

getPersistentJSON(): string
Returns string
Undocumented
Inherited from SharedObservable.getPersistentJSON
- Defined in src/types/Native.ts:214

inProgressDownload

inProgressDownload(DI): boolean
Returns whether the given download item is currently in download progress
Parameters
- DI: DownloadItem
Returns boolean
- Defined in src/types/Native.ts:7371

initDownload

initDownload(aDI, QueueType): boolean
Parameters
- aDI: DownloadItem
- QueueType: DownloadQueueType
Returns boolean
Undocumented
- Defined in src/types/Native.ts:7343

isMarked

isMarked(id): boolean
Parameters
- id: number
Returns boolean
Undocumented
Inherited from SharedObservable.isMarked
- Defined in src/types/Native.ts:212

locked

locked(func): void
Call defined method with locked data so user can access them.
Parameters
- func: (() => any)
  Method to call
  - - (): any
    - Returns any
Returns void
Inherited from SharedObservable.locked
- Defined in src/types/Native.ts:192

modifyAsync

modifyAsync(...params): Promise<any>
Call defined method with the item locked for modifications.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedObservable.modifyAsync
- Defined in src/types/Native.ts:262

notifyChanged

notifyChanged(...params): void
Notifies that the object was changed (e.g. to force visual update etc.)
Parameters
- Rest ...params: any[]
Returns void
Inherited from SharedObservable.notifyChanged
- Defined in src/types/Native.ts:308

pauseAllDownloads

pauseAllDownloads(): void
Pauses all pending downloads

Returns void
- Defined in src/types/Native.ts:7403

pauseDownload

pauseDownload(DI): void
Pauses download item
Parameters
- DI: DownloadItem
Returns void
- Defined in src/types/Native.ts:7357

readDownloadsFromDB

readDownloadsFromDB(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:7428

refreshDownloadValues

refreshDownloadValues(URL, destination, Read, Total, PauseIsPossible): void
Parameters
- URL: string
- destination: string
- Read: number
- Total: number
- PauseIsPossible: boolean
Returns void
Undocumented
- Defined in src/types/Native.ts:7397

resumeAllDownloads

resumeAllDownloads(): void
Resumes paused downloads

Returns void
- Defined in src/types/Native.ts:7408

resumeDownload

resumeDownload(DI, startImmediatelly): void
Resumes the paused download item
Parameters
- DI: DownloadItem
- startImmediatelly: boolean
Returns void
- Defined in src/types/Native.ts:7351

setMarked

setMarked(id, value): void
Parameters
- id: number
- value: boolean
Returns void
Undocumented
Inherited from SharedObservable.setMarked
- Defined in src/types/Native.ts:211

toString

toString(): string
Returns string
Undocumented
Inherited from SharedObservable.toString
- Defined in src/types/Native.ts:264

toUriString

toUriString(): string
Returns string
Undocumented
Inherited from SharedObservable.toUriString
- Defined in src/types/Native.ts:263

updateStatus

updateStatus(): void
Returns void
Undocumented
Inherited from SharedObservable.updateStatus
- Defined in src/types/Native.ts:297

Events

event_change

event_change: ((changeType, ...additionalArgs) => void)

Event is called when object is somehow changed

See App.listen

Type declaration

- (changeType, ...additionalArgs): void
- Parameters
  - changeType: string
    additional change type (can have values like 'tracklist', 'deleted', 'title' or undefined)
  - Rest ...additionalArgs: any[]
  Returns void

Example

app.listen(object, 'change', (changeType) => {  });

event_destroying

event_destroying: (() => void)

Event is called when object is going to destroy

See App.listen

Type declaration

- (): void
- Returns void

event_statuschange

event_statuschange: (() => void)

Event is called when status info of the object is changed

See App.listen

Type declaration

- (): void
- Returns void

Class Downloader

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns Downloader

Properties

asJSON

deleted

dontNotify

Undocumented

id

isObservable

isStatusBarSource

itemList

Returns

objectType

persistentID

statusInfo

Undocumented

streamUrlRequests

Undocumented

title

Methods

anyDownloadExists

Parameters

Returns boolean

Undocumented

anyDownloadInProgress

Returns boolean

anyDownloadIsPaused

Returns boolean

beginUpdate

Returns void

cancelAllDownloads

Returns void

cancelDownload

Parameters

Returns void

cancelDownloads

Parameters

Returns void

Undocumented

checkDownloadsQueue

Returns void

Undocumented

checkUpdate

Parameters

Returns void

commit

Returns void

Undocumented

commitAsync

Returns Promise<any>

doCut

Parameters

Returns Promise<any>

Undocumented

downloadFinished

Parameters

Returns void

Undocumented

downloadTrack

Parameters

Returns void

Undocumented

endUpdate

Returns boolean

getClassName

Returns string

getDownloadItem

Parameters

Returns DownloadItem

getDownloadsCount

Returns number

getPersistentJSON