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

fun getStartTime(): Double

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

getState

fun getState(): DownloadItemGetStateResult

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

getTotalBytes

fun getTotalBytes(): Double

The total size in bytes of the download item.

getURL

fun getURL(): String

The origin URL where the item is downloaded from.

getURLChain

fun getURLChain(): ReadonlyArray<String>

The complete URL chain of the item including any redirects.

hasUserGesture

fun hasUserGesture(): Boolean

Whether the download has user gesture.

isPaused

fun isPaused(): Boolean

Whether the download is paused.

off

fun off(event: DownloadItemEvent.DONE, listener: (event: Event<*>, state: DownloadItemDoneListenerState) -> Unit)

fun off(event: DownloadItemEvent.UPDATED, listener: (event: Event<*>, state: DownloadItemUpdatedListenerState) -> Unit)

fun on(event: DownloadItemEvent.DONE, listener: (event: Event<*>, state: DownloadItemDoneListenerState) -> Unit)

Emitted when the download is in a terminal state. This includes a completed download, a cancelled download (via downloadItem.cancel()), and interrupted download that can't be resumed.

fun on(event: DownloadItemEvent.UPDATED, listener: (event: Event<*>, state: DownloadItemUpdatedListenerState) -> Unit)

Emitted when the download has been updated and is not done.

once

fun once(event: DownloadItemEvent.DONE, listener: (event: Event<*>, state: DownloadItemDoneListenerState) -> Unit)

fun once(event: DownloadItemEvent.UPDATED, listener: (event: Event<*>, state: DownloadItemUpdatedListenerState) -> Unit)

pause

fun pause()

Pauses the download.

removeListener

fun removeListener(event: DownloadItemEvent.DONE, listener: (event: Event<*>, state: DownloadItemDoneListenerState) -> Unit)

fun removeListener(event: DownloadItemEvent.UPDATED, listener: (event: Event<*>, state: DownloadItemUpdatedListenerState) -> Unit)

resume

fun resume()

Resumes the download that has been paused.

setMaxListeners

fun setMaxListeners(n: Number)

setSaveDialogOptions

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

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.