Skip to content

BrowserScreenshotRequest.md

Latest commit

 

History

History
34 lines (28 loc) · 1.4 KB

BrowserScreenshotRequest.md

File metadata and controls

34 lines (28 loc) · 1.4 KB
Raw

Unifapi::BrowserScreenshotRequest

Properties

Name Type Description Notes
url String Absolute http(s) URL of the page to render.
wait_until String When navigation is considered complete. `networkidle0` waits for the network to go idle (best for JavaScript-heavy pages); `load` is fastest. [optional]
timeout_ms Integer Navigation timeout in milliseconds (1000–60000). [optional]
viewport BrowserScreenshotRequestViewport [optional]
full_page Boolean Capture the full scrollable page instead of just the viewport. [optional]
format String Output image format. [optional][default to 'png']
quality Integer Compression quality (0–100). Only valid for `jpeg` and `webp`. [optional]
selector String Capture only the first element matching this CSS selector. [optional]
omit_background Boolean Render a transparent background (ignored for `jpeg`). [optional]

Example

require 'unifapi'

instance = Unifapi::BrowserScreenshotRequest.new(
  url: null,
  wait_until: null,
  timeout_ms: null,
  viewport: null,
  full_page: null,
  format: null,
  quality: null,
  selector: null,
  omit_background: null
)