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.failure() は 'canceled' に解決されます。
使用例
Download.cancel();
戻り値
createReadStream
バージョン v1.9 より前に追加成功したダウンロードのための読み取り可能なストリームを返します。失敗/キャンセルされたダウンロードの場合は例外をスローします。
使用例
Download.createReadStream();
戻り値
delete
バージョン v1.9 より前に追加ダウンロードしたファイルを削除します。必要に応じてダウンロードが完了するまで待機します。
使用例
Download.delete();
戻り値
failure
バージョン v1.9 より前に追加ダウンロードエラーがあれば返します。必要に応じてダウンロードが完了するまで待機します。
使用例
Download.failure();
戻り値
page
バージョン v1.12 で追加ダウンロードが属するページを取得します。
使用例
Download.page();
戻り値
path
バージョン v1.9 より前に追加成功したダウンロードの場合、ダウンロードしたファイルへのパスを返します。失敗/キャンセルされたダウンロードの場合は例外をスローします。このメソッドは必要に応じてダウンロードが完了するまで待機します。リモート接続されている場合は例外をスローします。
ダウンロードのファイル名はランダムな GUID であることに注意してください。推奨されるファイル名を取得するには、Download.suggestedFilename() を使用してください。
使用例
Download.path();
戻り値
saveAs
バージョン v1.9 より前に追加ダウンロードをユーザー指定のパスにコピーします。ダウンロードがまだ進行中でもこのメソッドを安全に呼び出すことができます。必要に応じてダウンロードが完了するまで待機します。
使用例
download.saveAs(Paths.get("/path/to/save/at/", download.suggestedFilename()));
引数
戻り値
suggestedFilename
バージョン v1.9 より前に追加このダウンロードに推奨されるファイル名を返します。通常、ブラウザによって Content-Disposition レスポンスヘッダーまたは download 属性から計算されます。whatwg の仕様を参照してください。ブラウザが異なると、計算に使用するロジックが異なる場合があります。
使用例
Download.suggestedFilename();
戻り値
url
バージョン v1.9 より前に追加ダウンロードされた URL を返します。
使用例
Download.url();
戻り値