Package com.microsoft.playwright

Interface Download

All Known Implementing Classes:
DownloadImpl
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.

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


 // Wait for the download to start
 Download download = page.waitForDownload(() -> {
     // Perform the action that initiates download
     page.getByText("Download file").click();
 });

 // Wait for the download process to complete and save the downloaded file somewhere
 download.saveAs(Paths.get("/path/to/save/at/", download.suggestedFilename()));

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancel()
    Cancels a download.
    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.
    Page
    page()
    Get the page that the download belongs to.
    Path
    path()
    Returns path to the downloaded file in case of successful download.
    void
    saveAs(Path path)
    Copy the download to a user-specified path.
    String
    suggestedFilename()
    Returns suggested filename for this download.
    String
    url()
    Returns downloaded url.

  • Method Details

    • cancel

      void cancel()
      Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations, download.failure() would resolve to "canceled".
      Since:
      v1.13

    • createReadStream

      InputStream createReadStream()
      Returns readable stream for current download or null if download failed.
      Since:
      v1.8

    • delete

      void delete()
      Deletes the downloaded file. Will wait for the download to finish if necessary.
      Since:
      v1.8

    • failure

      String failure()
      Returns download error if any. Will wait for the download to finish if necessary.
      Since:
      v1.8

    • page

      Page page()
      Get the page that the download belongs to.
      Since:
      v1.12

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

      Note that the download's file name is a random GUID, use Download.suggestedFilename() to get suggested file name.

      Since:
      v1.8

    • saveAs

      void saveAs(Path path)
      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** 

      
 download.saveAs(Paths.get("/path/to/save/at/", download.suggestedFilename()));
      Parameters:
      path - Path where the download should be copied.
      Since:
      v1.8

    • 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.
      Since:
      v1.8

    • url

      String url()
      Returns downloaded url.
      Since:
      v1.8