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();
戻り値