Download

Download 对象通过 page 的 Page.Download 事件分发。

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

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();

返回值

• void#

---

CreateReadStreamAsync

添加于 v1.9 之前 download.CreateReadStreamAsync

对于成功下载，返回可读流；对于失败/已取消的下载，则抛出异常。

用法

await Download.CreateReadStreamAsync();

返回值

• [Stream]#

---

DeleteAsync

添加于 v1.9 之前 download.DeleteAsync

删除下载的文件。如有必要，将等待下载完成。

用法

await Download.DeleteAsync();

返回值

• void#

---

FailureAsync

添加于 v1.9 之前 download.FailureAsync

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

用法

await Download.FailureAsync();

返回值

• string?#

---

Page

添加于：v1.12 download.Page

获取下载所属的页面。

用法

Download.Page

返回值

• Page#

---

PathAsync

添加于 v1.9 之前 download.PathAsync

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

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

用法

await Download.PathAsync();

返回值

• string#

---

SaveAsAsync

添加于 v1.9 之前 download.SaveAsAsync

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

用法

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

参数

• path string#

  应复制下载文件的路径。

返回值

• void#

---

SuggestedFilename

添加于 v1.9 之前 download.SuggestedFilename

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

用法

Download.SuggestedFilename

返回值

• string#

---

Url

添加于 v1.9 之前 download.Url

返回下载的 url。

用法

Download.Url

返回值

• string#