com.microsoft.playwright

Interface Download

public interface Download

Download objects are dispatched by page via the Page.onDownload() event.

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

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

 // wait for download to start
 Download download  = page.waitForDownload(() -> page.click("a"));
 // wait for download to complete
 Path path = download.path();
 

 // wait for download to start
 Download download = page.waitForDownload(() -> {
   page.click("a");
 });
 // wait for download to complete
 Path path = download.path();
 

NOTE: Browser context **must** be created with the acceptDownloads set to true when user needs access to the downloaded content. If acceptDownloads is not set, download events are emitted, but the actual download is not performed and user has no access to the downloaded files.

Method Summary

Modifier and Type	Method and Description
InputStream	createReadStream() Returns readable stream for current download or null if download failed.
void	delete() Deletes the downloaded file.
String	failure() Returns download error if any.
Path	path() Returns path to the downloaded file in case of successful download.
void	saveAs(Path path) Saves the download to a user-specified path.
String	suggestedFilename() Returns suggested filename for this download.
String	url() Returns downloaded url.

Method Detail

createReadStream

InputStream createReadStream()

Returns readable stream for current download or null if download failed.

delete

void delete()

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

failure

String failure()

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

path

Path path()

Returns path to the downloaded file in case of successful download. The method will wait for the download to finish if necessary. The method throws when connected remotely.

saveAs

void saveAs(Path path)

Saves the download to a user-specified path. It is safe to call this method while the download is still in progress.

Parameters:

path - Path where the download should be saved.

suggestedFilename

String 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.

url

String url()

Returns downloaded url.