- 类:downloadItem
- 事件
- 实例方法
downloadItem.setSavePath(path)
downloadItem.getSavePath()
downloadItem.setSaveDialogOptions(options)
downloadItem.getSaveDialogOptions()
downloadItem.pause()
downloadItem.isPaused()
downloadItem.resume()
downloadItem.canResume()
downloadItem.cancel()
downloadItem.getURL()
downloadItem.getMimeType()
downloadItem.hasUserGesture()
downloadItem.getFilename()
downloadItem.getTotalBytes()
downloadItem.getReceivedBytes()
downloadItem.getContentDisposition()
downloadItem.getState()
downloadItem.getURLChain()
downloadItem.getLastModifiedTime()
downloadItem.getETag()
downloadItem.getStartTime()
- 实例属性
类:downloadItem
控制来自于远程资源的文件下载。
线程:主线程
DownloadItem
is an EventEmitter that represents a download item in Electron. 它用于will-download
事件以及Session
类,并且允许用户控制下载项目。
// 在主进程中.
const { BrowserWindow } = require('electron')
let 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
Eventstate
String - 可以是progressing
或interrupted
.
当下载正在执行但还没完成的时候发出。
状态可以是以下之一:
progressing
- 下载正在进行中interrupted
- 下载已经中断,可以恢复
事件名: ‘done’
返回:
event
Eventstate
String - 可以是completed
,cancelled
或interrupted
.
当下载文件已经到本地时发出。这包括一个完整的下载,取消下载(downloadItem.cancel()
)和中断不可恢复的下载。
状态可以是以下之一:
completed
- 下载成功完成cancelled
- 下载已被取消interrupted
- 下载已经中断,无法恢复
实例方法
downloadItem
对象具有以下方法:
downloadItem.setSavePath(path)
path
String - 设置下载项目的保存文件路径。
该API仅能在will-download
方法的回调中使用。 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.
Deprecated: use the savePath
property instead.
downloadItem.getSavePath()
返回 String
- 下载项目的保存路径。这将是通过downloadItem.setSavePath(path)
设置的路径,或从显示的保存对话框中选择的路径。
Deprecated: use the savePath
property instead.
downloadItem.setSaveDialogOptions(options)
options
SaveDialogOptions - Set the save file dialog options. This object has the same properties as theoptions
parameter ofdialog.showSaveDialog()
.
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.
downloadItem.getSaveDialogOptions()
Returns SaveDialogOptions
- Returns the object previously set by downloadItem.setSaveDialogOptions(options)
.
downloadItem.pause()
暂停下载。
downloadItem.isPaused()
返回Boolean
- 下载是否暂停。
downloadItem.resume()
恢复已暂停的下载。
笔记: 为了支持断点下载,必须要从支持范围内请求下载,并且提供Last-Modified
和 ETag
的值。 否则,resume()
将关闭以前接收到的字节并从头开始重新开始下载。
downloadItem.canResume()
返回Boolean
- 下载是否可以恢复。
downloadItem.cancel()
取消下载操作。
downloadItem.getURL()
Returns String
- The origin URL where the item is downloaded from.
downloadItem.getMimeType()
返回String
- MIME类型的文件。
downloadItem.hasUserGesture()
返回Boolean
- 下载是否具有用户手势。
downloadItem.getFilename()
返回String
- 下载项目的文件名。
笔记:文件名与本地磁盘中保存的实际文件名不尽相同。 如果用户在提示的下载保存对话框中更改文件名称,保存的文件的实际名称将会不同。
downloadItem.getTotalBytes()
返回Integer
- 下载项目的总大小(以字节为单位)。
如果大小未知,则返回0。
downloadItem.getReceivedBytes()
返回Integer
- 下载项目的接收字节。
downloadItem.getContentDisposition()
返回String
- 响应头中的Content-Disposition字段。
downloadItem.getState()
返回 String
- 表示当前状态。可能是 progressing
, completed
, cancelled
或者 interrupted
。
笔记: 以下方法特别有助于在会话重新启动时恢复取消的项目。
downloadItem.getURLChain()
Returns String[]
- The complete URL chain of the item including any redirects.
downloadItem.getLastModifiedTime()
返回String - Last-Modified的值。
downloadItem.getETag()
返回String - ETag的值。
downloadItem.getStartTime()
返回Double
- 自下载开始时的UNIX纪元以来的秒数。
实例属性
downloadItem.savePath
A String
property that determines the save file path of the download item.
The property is only available in session’s will-download
callback function. If user doesn’t set the save path via the property, Electron will use the original routine to determine the save path; this usually prompts a save dialog.