Package com.microsoft.playwright
Interface Download
-
public interface Download
Download 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. All downloaded files are deleted when the browser closes.
Download event is emitted once the download starts. Download path becomes available
once download completes:
NOTE Browser context **must** be created with the
acceptDownloads
set totrue
when user needs access to the downloaded content. IfacceptDownloads
is not set or set tofalse
, download events are emitted, but the actual download is not performed and user has no access to the downloaded files.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InputStream
createReadStream()
Returns readable stream for current download ornull
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 ornull
if download failed.
-
delete
void delete()
Deletes the downloaded file.
-
failure
String failure()
Returns download error if any.
-
path
Path path()
Returns path to the downloaded file in case of successful download.
-
saveAs
void saveAs(Path path)
Saves the download to a user-specified path.- 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 theContent-Disposition
response header or thedownload
attribute. See the spec on whatwg. Different browsers can use different logic for computing it.
-
url
String url()
Returns downloaded url.
-
-