跳到主要內容

Download

Download 物件由頁面透過 Page.onDownload(handler) 事件分派。

當瀏覽器 context 關閉時，所有屬於該瀏覽器 context 的下載檔案都會被刪除。

下載事件會在下載開始時發出。下載路徑會在下載完成後才可使用。

// 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

為成功的下載回傳可讀取的 stream，或為失敗/取消的下載拋出例外。

用法

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

回傳