class Playwright::Download
`Download` objects are dispatched by page via the [`event: Page.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:
“`python sync with page.expect_download() as download_info:
page.click("a")
download = download_info.value # wait for download to complete 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.
Public Instance Methods
Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations, `download.failure()` would resolve to `'canceled'`.
# File lib/playwright_api/download.rb, line 23 def cancel wrap_impl(@impl.cancel) end
Deletes the downloaded file. Will wait for the download to finish if necessary.
# File lib/playwright_api/download.rb, line 28 def delete wrap_impl(@impl.delete) end
Returns download error if any. Will wait for the download to finish if necessary.
# File lib/playwright_api/download.rb, line 33 def failure wrap_impl(@impl.failure) end
Get the page that the download belongs to.
# File lib/playwright_api/download.rb, line 38 def page wrap_impl(@impl.page) end
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 [`method: Download.suggestedFilename`] to get suggested file name.
# File lib/playwright_api/download.rb, line 47 def path wrap_impl(@impl.path) end
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.
# File lib/playwright_api/download.rb, line 53 def save_as(path) wrap_impl(@impl.save_as(unwrap_impl(path))) end
Returns suggested filename for this download. It is typically computed by the browser from the [`Content-Disposition`](developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) response header or the `download` attribute. See the spec on [whatwg](html.spec.whatwg.org/#downloading-resources). Different browsers can use different logic for computing it.
# File lib/playwright_api/download.rb, line 61 def suggested_filename wrap_impl(@impl.suggested_filename) end
Returns downloaded url.
# File lib/playwright_api/download.rb, line 66 def url wrap_impl(@impl.url) end