Class: Playwright::Download
- Inherits:
-
PlaywrightApi
- Object
- PlaywrightApi
- Playwright::Download
- Defined in:
- lib/playwright_api/download.rb
Overview
‘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 # Start waiting for the download with page.expect_download() as download_info:
# Perform the action that initiates download
page.get_by_text("Download file").click()
download = download_info.value
# Wait for the download process to complete and save the downloaded file somewhere download.save_as(“/path/to/save/at/” + download.suggested_filename) “‘
Instance Method Summary collapse
-
#cancel ⇒ Object
Cancels a download.
-
#delete ⇒ Object
Deletes the downloaded file.
-
#failure ⇒ Object
Returns download error if any.
-
#page ⇒ Object
Get the page that the download belongs to.
-
#path ⇒ Object
Returns path to the downloaded file for a successful download, or throws for a failed/canceled download.
-
#save_as(path) ⇒ Object
Copy the download to a user-specified path.
-
#suggested_filename ⇒ Object
Returns suggested filename for this download.
-
#url ⇒ Object
Returns downloaded url.
Methods inherited from PlaywrightApi
Constructor Details
This class inherits a constructor from Playwright::PlaywrightApi
Instance Method Details
#cancel ⇒ Object
Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations, ‘download.failure()` would resolve to `’canceled’‘.
25 26 27 |
# File 'lib/playwright_api/download.rb', line 25 def cancel wrap_impl(@impl.cancel) end |
#delete ⇒ Object
Deletes the downloaded file. Will wait for the download to finish if necessary.
31 32 33 |
# File 'lib/playwright_api/download.rb', line 31 def delete wrap_impl(@impl.delete) end |
#failure ⇒ Object
Returns download error if any. Will wait for the download to finish if necessary.
37 38 39 |
# File 'lib/playwright_api/download.rb', line 37 def failure wrap_impl(@impl.failure) end |
#page ⇒ Object
Get the page that the download belongs to.
43 44 45 |
# File 'lib/playwright_api/download.rb', line 43 def page wrap_impl(@impl.page) end |
#path ⇒ Object
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 [‘method: Download.suggestedFilename`] to get suggested file name.
52 53 54 |
# File 'lib/playwright_api/download.rb', line 52 def path wrap_impl(@impl.path) end |
#save_as(path) ⇒ Object
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
“‘python sync download.save_as(“/path/to/save/at/” + download.suggested_filename) “`
65 66 67 |
# File 'lib/playwright_api/download.rb', line 65 def save_as(path) wrap_impl(@impl.save_as(unwrap_impl(path))) end |
#suggested_filename ⇒ Object
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.
74 75 76 |
# File 'lib/playwright_api/download.rb', line 74 def suggested_filename wrap_impl(@impl.suggested_filename) end |
#url ⇒ Object
Returns downloaded url.
80 81 82 |
# File 'lib/playwright_api/download.rb', line 80 def url wrap_impl(@impl.url) end |