The save path of the download item. This will be either the path set via downloadItem.setSavePath(path) or the path selected from the shown save dialog.

getStartTime

external fun getStartTime(): Double

Number of seconds since the UNIX epoch when the download was started.

getState

external fun getState(): DownloadItemGetStateResult

The current state. Can be progressing, completed, cancelled or interrupted.

getTotalBytes

external fun getTotalBytes(): Double

The total size in bytes of the download item.

getURL

external fun getURL(): String

The origin URL where the item is downloaded from.

getURLChain

external fun getURLChain(): ReadonlyArray<String>

The complete URL chain of the item including any redirects.

hasUserGesture

external fun hasUserGesture(): Boolean

Whether the download has user gesture.

isPaused

external fun isPaused(): Boolean

Whether the download is paused.

listenerCount

external fun listenerCount(type: EventType, listener: EventListener): Double

listeners

external fun listeners(type: EventType): ReadonlyArray<EventListener>

off

external fun off(type: EventType, listener: EventListener)

external fun on(type: EventType, listener: EventListener)

once

external fun once(type: EventType, listener: EventListener)

pause

external fun pause()

Pauses the download.

prependListener

external fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

external fun prependOnceListener(type: EventType, listener: EventListener)

rawListeners

external fun rawListeners(type: EventType): ReadonlyArray<EventListener>

removeAllListeners

external fun removeAllListeners(type: EventType)

removeListener

external fun removeListener(type: EventType, listener: EventListener)

resume

external fun resume()

Resumes the download that has been paused.

setMaxListeners

external fun setMaxListeners(n: Number)

setSaveDialogOptions

external fun setSaveDialogOptions(options: SaveDialogOptions)

This API allows the user to set custom options for the save dialog that opens for the download item by default. The API is only available in session's will-download callback function.

setSavePath

external fun setSavePath(path: String)

The API is only available in session's will-download callback function. If path doesn't exist, Electron will try to make the directory recursively. If user doesn't set the save path via the API, Electron will use the original routine to determine the save path; this usually prompts a save dialog.