类: DownloadItem

类: DownloadItem

控制来自远程源的文件下载。

进程: 主进程
该类不从 'electron' 模块导出。它仅作为 Electron API 中其他方法的返回值提供。

DownloadItem 是一个 EventEmitter，代表 Electron 中的一个下载项。它用于 Session 类的 will-download 事件，并允许用户控制下载项。

// In the main process.
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
win.webContents.session.on('will-download', (event, item, webContents) => {
  // Set the save path, making Electron not to prompt a save dialog.
  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 Event
• state string - 可以是 progressing 或 interrupted。

当下载已更新但未完成时触发。

state 可以是以下状态之一：

• progressing - 下载正在进行中。
• interrupted - 下载已中断且可以恢复。

事件: 'done'

返回值

• event Event
• state string - 可以是 completed, cancelled 或 interrupted。

当下载处于终止状态时触发。这包括已完成的下载、已取消的下载 (通过 downloadItem.cancel()) 和无法恢复的中断下载。

state 可以是以下状态之一：

• completed - 下载成功完成。
• cancelled - 下载已被取消。
• interrupted - 下载已中断且无法恢复。

实例方法

downloadItem 对象具有以下方法：

downloadItem.setSavePath(path)

• path string - 设置下载项的保存文件路径。

此 API 仅在 session 的 will-download 回调函数中可用。如果 path 不存在，Electron 将尝试递归创建目录。如果用户未通过此 API 设置保存路径，Electron 将使用原始例程来确定保存路径；这通常会弹出一个保存对话框。

downloadItem.getSavePath()

返回 string - 下载项的保存路径。这将是使用 downloadItem.setSavePath(path) 设置的路径，或者从显示的保存对话框中选择的路径。

downloadItem.setSaveDialogOptions(options)

• options SaveDialogOptions - 设置保存文件对话框的选项。此对象具有与 dialog.showSaveDialog() 的 options 参数相同的属性。

此 API 允许用户为下载项默认打开的保存对话框设置自定义选项。此 API 仅在 session 的 will-download 回调函数中可用。

downloadItem.getSaveDialogOptions()

返回 SaveDialogOptions - 返回先前通过 downloadItem.setSaveDialogOptions(options) 设置的对象。

downloadItem.pause()

暂停下载。

downloadItem.isPaused()

返回 boolean - 下载是否已暂停。

downloadItem.resume()

恢复已暂停的下载。

注意：要启用可恢复的下载，你从中下载的服务器必须支持范围请求并提供 Last-Modified 和 ETag 头部值。否则，resume() 将丢弃之前接收的字节并从头开始重新下载。

downloadItem.canResume()

返回 boolean - 下载是否可以恢复。

downloadItem.cancel()

取消下载操作。

downloadItem.getURL()

返回 string - 下载项的原始 URL。

downloadItem.getMimeType()

返回 string - 文件的 MIME 类型。

downloadItem.hasUserGesture()

返回 boolean - 下载是否由用户手势触发。

downloadItem.getFilename()

返回 string - 下载项的文件名。

注意：文件名并不总是与本地磁盘中保存的实际文件名相同。如果用户在弹出的下载保存对话框中更改了文件名，实际保存的文件名将不同。

downloadItem.getCurrentBytesPerSecond()

返回 Integer - 当前下载速度 (字节/秒)。

downloadItem.getTotalBytes()

返回 Integer - 下载项的总大小 (字节)。

如果大小未知，则返回 0。

downloadItem.getReceivedBytes()

返回 Integer - 已接收的下载字节数。

downloadItem.getPercentComplete()

返回 Integer - 下载完成百分比。

downloadItem.getContentDisposition()

返回 string - 响应头部中的 Content-Disposition 字段。

downloadItem.getState()

返回 string - 当前状态。可以是 progressing, completed, cancelled 或 interrupted。

注意：以下方法特别有助于在 session 重启时恢复一个 cancelled 项。

downloadItem.getURLChain()

返回 string[] - 下载项完整的 URL 链，包括所有重定向。

downloadItem.getLastModifiedTime()

返回 string - Last-Modified 头部值。

downloadItem.getETag()

返回 string - ETag 头部值。

downloadItem.getStartTime()

返回 Double - 下载开始时的 UNIX 纪元秒数。

downloadItem.getEndTime()

返回 Double - 下载结束时的 UNIX 纪元秒数。

实例属性

downloadItem.savePath

一个 string 属性，用于确定下载项的保存文件路径。

此属性仅在 session 的 will-download 回调函数中可用。如果用户未通过此属性设置保存路径，Electron 将使用原始例程来确定保存路径；这通常会弹出一个保存对话框。