メインコンテンツにスキップ

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

戻り値