跳到主要内容

Download

Download 对象通过 Page.onDownload(handler) 事件由页面分发。

当浏览器上下文关闭时，属于该浏览器上下文的所有已下载文件都将被删除。

下载事件在下载开始时发出。下载路径在下载完成后可用。

// Wait for the download to start
Download download = page.waitForDownload(() -> {
    // Perform the action that initiates download
    page.getByText("Download file").click();
});

// Wait for the download process to complete and save the downloaded file somewhere
download.saveAs(Paths.get("/path/to/save/at/", download.suggestedFilename()));

方法​

cancel​

添加于: v1.13 download.cancel

取消下载。如果下载已完成或已取消，则不会失败。成功取消后，download.failure() 将解析为 'canceled'。

用法

Download.cancel();

返回值

createReadStream​

早于 v1.9 添加 download.createReadStream

为成功的下载返回可读流，或为失败/取消的下载抛出异常。

用法

Download.createReadStream();

返回值

delete​

早于 v1.9 添加 download.delete

删除已下载的文件。如果需要，将等待下载完成。

用法

Download.delete();

返回值

failure​

早于 v1.9 添加 download.failure

返回下载错误（如果有）。如果需要，将等待下载完成。

用法

Download.failure();

返回值

page​

添加于: v1.12 download.page

获取下载所属的页面。

用法

Download.page();

返回值

path​

早于 v1.9 添加 download.path

为成功的下载返回已下载文件的路径，或为失败/取消的下载抛出异常。如有必要，此方法将等待下载完成。远程连接时，此方法会抛出异常。

请注意，下载的文件名是随机 GUID，使用 Download.suggestedFilename() 获取建议的文件名。

用法

Download.path();

返回值

saveAs​

早于 v1.9 添加 download.saveAs

将下载内容复制到用户指定的路径。在下载仍在进行中时调用此方法是安全的。如有必要，将等待下载完成。

用法

download.saveAs(Paths.get("/path/to/save/at/", download.suggestedFilename()));

参数

  • path Path#

    应将下载内容复制到的路径。

返回值

suggestedFilename​

早于 v1.9 添加 download.suggestedFilename

返回此下载的建议文件名。它通常由浏览器从 Content-Disposition 响应头或 download 属性计算得出。请参阅 whatwg 上的规范。不同的浏览器可以使用不同的逻辑来计算它。

用法

Download.suggestedFilename();

返回值

url​

早于 v1.9 添加 download.url

返回已下载的 URL。

用法

Download.url();

返回值