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

Download

Download オブジェクトは、Page.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();

戻り値


CreateReadStreamAsync

v1.9より前に追加 download.CreateReadStreamAsync

ダウンロードが成功した場合は読み取り可能なストリームを返し、失敗/キャンセルされたダウンロードの場合はスローします。

使用法

await Download.CreateReadStreamAsync();

戻り値

  • [Stream]#

DeleteAsync

v1.9より前に追加 download.DeleteAsync

ダウンロードされたファイルを削除します。必要であれば、ダウンロードが完了するまで待機します。

使用法

await Download.DeleteAsync();

戻り値


FailureAsync

v1.9より前に追加 download.FailureAsync

ダウンロードエラーがあれば返します。必要であれば、ダウンロードが完了するまで待機します。

使用法

await Download.FailureAsync();

戻り値


Page

追加日: v1.12 download.Page

ダウンロードが属するページを取得します。

使用法

Download.Page

戻り値


PathAsync

v1.9より前に追加 download.PathAsync

ダウンロードが成功した場合はダウンロードされたファイルへのパスを返し、失敗/キャンセルされたダウンロードの場合はスローします。このメソッドは必要に応じてダウンロードが完了するまで待機します。リモート接続されている場合はこのメソッドはスローします。

ダウンロードのファイル名はランダムな GUID であることに注意してください。Download.SuggestedFilename を使用して推奨ファイル名を取得してください。

使用法

await Download.PathAsync();

戻り値


SaveAsAsync

v1.9より前に追加 download.SaveAsAsync

ダウンロードをユーザー指定のパスにコピーします。ダウンロードが進行中でもこのメソッドを呼び出すのは安全です。必要に応じてダウンロードが完了するまで待機します。

使用法

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

引数

  • path string#

    ダウンロードをコピーするパス。

戻り値


SuggestedFilename

v1.9より前に追加 download.SuggestedFilename

このダウンロードの提案されたファイル名を返します。これは通常、ブラウザがContent-Disposition応答ヘッダーまたはdownload属性から計算します。whatwgの仕様を参照してください。異なるブラウザは、計算に異なるロジックを使用する場合があります。

使用法

Download.SuggestedFilename

戻り値


Url

v1.9より前に追加 download.Url

ダウンロードされたURLを返します。

使用法

Download.Url

戻り値