跳到主要内容

Download

下载(Download) 对象由页面通过 Page.Download 事件派发。

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

下载开始时会触发 Download 事件。下载完成后,下载路径就可用了。

// 在点击之前启动等待下载的任务
var waitForDownloadTask = page.WaitForDownloadAsync();
await page.GetByText("Download file").ClickAsync();
var download = await waitForDownloadTask;

// 等待下载过程完成,并将下载的文件保存到某个位置
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

返回值