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

Download

Download オブジェクトは、Page.Download イベントを介してページによってディスパッチされます。

ブラウザコンテキストに属するすべてのダウンロードファイルは、ブラウザコンテキストが閉じられると削除されます。

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

Added in: v1.13 download.CancelAsync

ダウンロードをキャンセルします。ダウンロードが既に完了またはキャンセルされている場合でも失敗しません。正常にキャンセルされると、download.failure()'canceled' に解決されます。

使用法

await Download.CancelAsync();

戻り値


CreateReadStreamAsync

Added before v1.9 download.CreateReadStreamAsync

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

使用法

await Download.CreateReadStreamAsync();

戻り値

  • [Stream]#

DeleteAsync

Added before v1.9 download.DeleteAsync

ダウンロードしたファイルを削除します。必要に応じて、ダウンロードが完了するまで待機します。

使用法

await Download.DeleteAsync();

戻り値


FailureAsync

Added before v1.9 download.FailureAsync

ダウンロードエラーがある場合は返します。必要に応じて、ダウンロードが完了するまで待機します。

使用法

await Download.FailureAsync();

戻り値


Page

Added in: v1.12 download.Page

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

使用法

Download.Page

戻り値


PathAsync

Added before v1.9 download.PathAsync

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

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

使用法

await Download.PathAsync();

戻り値


SaveAsAsync

Added before v1.9 download.SaveAsAsync

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

使用法

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

引数

  • path string#

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

戻り値


SuggestedFilename

Added before v1.9 download.SuggestedFilename

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

使用法

Download.SuggestedFilename

戻り値


Url

Added before v1.9 download.Url

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

使用法

Download.Url

戻り値