Class: ContextDev::Models::WebScreenshotParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::WebScreenshotParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/context_dev/models/web_screenshot_params.rb

Overview

See Also:

• Resources::Web#screenshot

Defined Under Namespace

Modules: ColorScheme, Country, FullScreenshot, HandleCookiePopup, Page Classes: Viewport

Instance Attribute Summary

• #color_scheme ⇒ Symbol, ...

  Optional parameter to choose the site’s visual theme in the screenshot.

• #country ⇒ Symbol, ...

  Two-letter ISO 3166-1 alpha-2 country code for the website request location.

• #direct_url ⇒ String^?

  A specific URL to screenshot directly, bypassing domain resolution (e.g., ‘example.com/pricing’).

• #domain ⇒ String^?

  Domain name to take screenshot of (e.g., ‘example.com’, ‘google.com’).

• #full_screenshot ⇒ Symbol, ...

  Optional parameter to determine screenshot type.

• #handle_cookie_popup ⇒ Symbol, ...

  Optional parameter to control cookie/consent popup handling.

• #max_age_ms ⇒ Integer^?

  Return a cached screenshot if a prior screenshot for the same parameters exists and is younger than this many milliseconds.

• #page ⇒ Symbol, ...

  Optional parameter to specify which page type to screenshot.

• #scroll_offset ⇒ Integer^?

  Optional vertical scroll offset in pixels for capturing a long page in viewport-sized chunks.

• #timeout_ms ⇒ Integer^?

  Optional timeout in milliseconds for the request.

• #viewport ⇒ ContextDev::Models::WebScreenshotParams::Viewport^?

  Optional browser viewport dimensions for the screenshot.

• #wait_for_ms ⇒ Integer^?

  Optional browser wait time in milliseconds after initial page load before taking the screenshot.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see WebScreenshotParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::WebScreenshotParams for more details.

Parameters:

• color_scheme (Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme) (defaults to: nil) —

  Optional parameter to choose the site’s visual theme in the screenshot. Use ‘lig

• country (Symbol, ContextDev::Models::WebScreenshotParams::Country) (defaults to: nil) —

  Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe

• direct_url (String) (defaults to: nil) —

  A specific URL to screenshot directly, bypassing domain resolution (e.g., ‘https

• domain (String) (defaults to: nil) —

  Domain name to take screenshot of (e.g., ‘example.com’, ‘google.com’). The domai

• full_screenshot (Symbol, ContextDev::Models::WebScreenshotParams::FullScreenshot) (defaults to: nil) —

  Optional parameter to determine screenshot type. If ‘true’, takes a full page sc

• handle_cookie_popup (Symbol, ContextDev::Models::WebScreenshotParams::HandleCookiePopup) (defaults to: nil) —

  Optional parameter to control cookie/consent popup handling. If ‘true’, we dismi

• max_age_ms (Integer) (defaults to: nil) —

  Return a cached screenshot if a prior screenshot for the same parameters exists

• page (Symbol, ContextDev::Models::WebScreenshotParams::Page) (defaults to: nil) —

  Optional parameter to specify which page type to screenshot. If provided, the sy

• scroll_offset (Integer) (defaults to: nil) —

  Optional vertical scroll offset in pixels for capturing a long page in viewport-

• timeout_ms (Integer) (defaults to: nil) —

  Optional timeout in milliseconds for the request. If the request takes longer th

• viewport (ContextDev::Models::WebScreenshotParams::Viewport) (defaults to: nil) —

  Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.

• wait_for_ms (Integer) (defaults to: nil) —

  Optional browser wait time in milliseconds after initial page load before taking

• request_options (ContextDev::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/context_dev/models/web_screenshot_params.rb', line 107

Instance Attribute Details

#color_scheme ⇒ Symbol, ...

Optional parameter to choose the site’s visual theme in the screenshot. Use ‘light’ or ‘dark’ when the site offers both appearances.

Returns:

• (Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 15

optional :color_scheme, enum: -> { ContextDev::WebScreenshotParams::ColorScheme }

#country ⇒ Symbol, ...

Two-letter ISO 3166-1 alpha-2 country code for the website request location. When provided, Context.dev fetches the target page from that country.

Returns:

• (Symbol, ContextDev::Models::WebScreenshotParams::Country, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 22

optional :country, enum: -> { ContextDev::WebScreenshotParams::Country }

#direct_url ⇒ String^?

A specific URL to screenshot directly, bypassing domain resolution (e.g., ‘example.com/pricing’). When provided, the screenshot is taken of this exact URL. You must provide either ‘domain’ or ‘directUrl’, but not both.

Returns:

• (String, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 30

optional :direct_url, String

#domain ⇒ String^?

Domain name to take screenshot of (e.g., ‘example.com’, ‘google.com’). The domain will be automatically normalized and validated. You must provide either ‘domain’ or ‘directUrl’, but not both.

Returns:

• (String, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 38

optional :domain, String

#full_screenshot ⇒ Symbol, ...

Optional parameter to determine screenshot type. If ‘true’, takes a full page screenshot capturing all content. If ‘false’ or not provided, takes a viewport screenshot (standard browser view).

Returns:

• (Symbol, ContextDev::Models::WebScreenshotParams::FullScreenshot, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 46

optional :full_screenshot, enum: -> { ContextDev::WebScreenshotParams::FullScreenshot }

#handle_cookie_popup ⇒ Symbol, ...

Optional parameter to control cookie/consent popup handling. If ‘true’, we dismiss cookie banner before capture. If ‘false’ or not provided, captures the page without that step.

Returns:

• (Symbol, ContextDev::Models::WebScreenshotParams::HandleCookiePopup, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 54

optional :handle_cookie_popup, enum: -> { ContextDev::WebScreenshotParams::HandleCookiePopup }

#max_age_ms ⇒ Integer^?

Return a cached screenshot if a prior screenshot for the same parameters exists and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 62

optional :max_age_ms, Integer

#page ⇒ Symbol, ...

Optional parameter to specify which page type to screenshot. If provided, the system will scrape the domain’s links and use heuristics to find the most appropriate URL for the specified page type (30 supported languages). If not provided, screenshots the main domain landing page. Only applicable when using ‘domain’, not ‘directUrl’.

Returns:

• (Symbol, ContextDev::Models::WebScreenshotParams::Page, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 72

optional :page, enum: -> { ContextDev::WebScreenshotParams::Page }

#scroll_offset ⇒ Integer^?

Optional vertical scroll offset in pixels for capturing a long page in viewport-sized chunks. When provided, the full page is captured once and the returned image is the viewport-sized slice that begins at this Y offset (e.g. request scrollOffset=0, then 1080, then 2160 to walk a 1920x1080 landing page top to bottom). The final slice may be shorter than the viewport height. Takes precedence over fullScreenshot. Max: 100000.

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 83

optional :scroll_offset, Integer

#timeout_ms ⇒ Integer^?

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 91

optional :timeout_ms, Integer

#viewport ⇒ ContextDev::Models::WebScreenshotParams::Viewport^?

Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.

Returns:

• (ContextDev::Models::WebScreenshotParams::Viewport, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 97

optional :viewport, -> { ContextDev::WebScreenshotParams::Viewport }

#wait_for_ms ⇒ Integer^?

Optional browser wait time in milliseconds after initial page load before taking the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when omitted.

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 105

optional :wait_for_ms, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/context_dev/models/web_screenshot_params.rb', line 145