Interface IDownload

Namespace

Microsoft.Playwright

Assembly

Microsoft.Playwright.dll

IDownload objects are dispatched by page via the Download event.

All the downloaded files belonging to the browser context are deleted when the browser context is closed.

Download event is emitted once the download starts. Download path becomes available once download completes.

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

public interface IDownload

Properties

Page

Get the page that the download belongs to.

IPage Page { get; }

Property Value

IPage

SuggestedFilename

Returns suggested filename for this download. It is typically computed by the browser from the Content-Disposition response header or the download attribute. See the spec on whatwg. Different browsers can use different logic for computing it.

string SuggestedFilename { get; }

Property Value

string

Url

Returns downloaded url.

string Url { get; }

Property Value

string

Methods

CancelAsync()

Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations, download.failure() would resolve to 'canceled'.

Task CancelAsync()

Returns

Task

CreateReadStreamAsync()

Returns a readable stream for a successful download, or throws for a failed/canceled download.

Task<Stream> CreateReadStreamAsync()

Returns

Task<Stream>

DeleteAsync()

Deletes the downloaded file. Will wait for the download to finish if necessary.

Task DeleteAsync()

Returns

Task

FailureAsync()

Returns download error if any. Will wait for the download to finish if necessary.

Task<string?> FailureAsync()

Returns

Task<string>

PathAsync()

Returns path to the downloaded file for a successful download, or throws for a failed/canceled download. The method will wait for the download to finish if necessary. The method throws when connected remotely.

Note that the download's file name is a random GUID, use SuggestedFilename to get suggested file name.

Task<string> PathAsync()

Returns

Task<string>

SaveAsAsync(string)

Copy the download to a user-specified path. It is safe to call this method while the download is still in progress. Will wait for the download to finish if necessary.

**Usage**

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

Task SaveAsAsync(string path)

Parameters

path string

Path where the download should be copied.

Returns

Task