跳至主要内容

下载

Download 对象由页面通过 Page.Download 事件分派。

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

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

// Start the task of waiting for the download before clicking
var waitForDownloadTask = page.WaitForDownloadAsync();
await page.GetByText("Download file").ClickAsync();
var download = await waitForDownloadTask;

// Wait for the download process to complete and save the downloaded file somewhere
await download.SaveAsAsync("/path/to/save/at/" + download.SuggestedFilename);

方法

CancelAsync

添加于: v1.13 download.CancelAsync

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

用法

await Download.CancelAsync();

返回值


CreateReadStreamAsync

添加于 v1.9 之前 download.CreateReadStreamAsync

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

用法

await Download.CreateReadStreamAsync();

返回值

  • [Stream]#

DeleteAsync

添加于 v1.9 之前 download.DeleteAsync

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

用法

await Download.DeleteAsync();

返回值


FailureAsync

添加于 v1.9 之前 download.FailureAsync

返回任何下载错误。如果需要,将等待下载完成。

用法

await Download.FailureAsync();

返回值


Page

添加于: v1.12 download.Page

获取下载所属的页面。

用法

Download.Page

返回值


PathAsync

添加于 v1.9 之前 download.PathAsync

为成功下载返回下载文件的路径,或为失败/取消的下载抛出异常。该方法将等待下载完成,如果需要。当远程连接时,该方法会抛出异常。

请注意,下载的文件名是一个随机的 GUID,使用 Download.SuggestedFilename 获取建议的文件名。

用法

await Download.PathAsync();

返回值


SaveAsAsync

添加于 v1.9 之前 download.SaveAsAsync

将下载复制到用户指定的路径。在下载仍在进行时调用此方法是安全的。如果需要,将等待下载完成。

用法

await download.SaveAsAsync("/path/to/save/at/" + download.SuggestedFilename);

参数

  • path string#

    应该复制下载的路径。

返回值


SuggestedFilename

添加于 v1.9 之前 download.SuggestedFilename

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

用法

Download.SuggestedFilename

返回值


Url

添加于 v1.9 之前 download.Url

返回下载的 URL。

用法

Download.Url

返回值