Class: DownloadItem
Class: DownloadItem
Контроль загрузки файлов из удаленных источников.
Процесс: Main
Этот класс не экспортируется из модуля 'electron'
. Он доступен только в качестве возвращаемого значения других методов в Electron API.
DownloadItem
это EventEmitter, который представляет элемент загрузки в Electron. Он используется в событии will-download
класса Session
и позволяет пользователям управлять элементом загрузки.
// В основном процессе.
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
win.webContents.session.on('will-download', (event, item, webContents) => {
// Установите путь сохранения, чтобы Electron не отображал диалоговое окно сохранения.
item.setSavePath('/tmp/save.pdf')
item.on('updated', (event, state) => {
if (state === 'interrupted') {
console.log('Download is interrupted but can be resumed')
} else if (state === 'progressing') {
if (item.isPaused()) {
console.log('Download is paused')
} else {
console.log(`Received bytes: ${item.getReceivedBytes()}`)
}
}
})
item.once('done', (event, state) => {
if (state === 'completed') {
console.log('Download successfully')
} else {
console.log(`Download failed: ${state}`)
}
})
})
События экземпляра
Событие: 'updated'
Возвращает:
- Событие типа
event
state
string - Can beprogressing
orinterrupted
.
Возникает, когда загрузка была обновлена и не завершена.
state
может быть одним из следующих:
progressing
- Загрузка находится в процессе загрузки.interrupted
- загрузка прервалась и может быть возобновлена.
Событие: 'done'
Возвращает:
- Событие типа
event
state
string - Can becompleted
,cancelled
orinterrupted
.
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.
state
может быть одним из следующих:
completed
- Загрузка завершена успешно.cancelled
- загрузка была отменена.interrupted
- загрузка прервалась и не может быть возобновлена.
Методы экземпляра
Объект downloadItem
имеет следующие методы:
downloadItem.setSavePath(path)
path
string - Set the save file path of the download item.
API доступен только в сессии will-download
функции обратного вызова. If path
doesn't exist, Electron will try to make the directory recursively. Если пользователь не устанавливает путь сохранения через API, Electron будет использовать исходную процедуру для определения пути сохранения; здесь обычно вызывается диалоговое окно сохранения.
downloadItem.getSavePath()
Returns string
- 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.
downloadItem.setSaveDialogOptions(options)
This API allows the user to set custom options for the save dialog that opens for the download item by default. API доступен только в сессии will-download
функции обратного вызова.
downloadItem.getSaveDialogOptions()
Возвращает SaveDialogOptions
- Возвращает ранее установленный объект downloadItem.setSaveDialogOptions(options)
.
downloadItem.pause()
Приостановить скачивание.
downloadItem.isPaused()
Returns boolean
- Whether the download is paused.