Class: ContextDev::Models::WebScreenshotParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/context_dev/models/web_screenshot_params.rb,
sig/context_dev/models/web_screenshot_params.rbs

Overview

See Also:

  • ContextDev::Resources::Web#screenshot

Defined Under Namespace

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

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ContextDev

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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(height: nil, width: nil) ⇒ Object

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

Parameters:

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

    Viewport height in pixels.

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

    Viewport width in pixels.




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

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:



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

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

#country ⇒ Symbol, ...

Fetch the target page through a residential proxy in this country (ISO 3166-1 alpha-2).

Returns:



22
 
# 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., 'https://example.com/pricing'). When provided, the screenshot is taken of this exact URL. You must provide either 'domain' or 'directUrl', but not both.

Parameters:

  • (String)

Returns:

  • (String, nil) 


30
 
# 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.

Parameters:

  • (String)

Returns:

  • (String, nil) 


38
 
# 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:



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

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

#handle_cookie_popup ⇒ Boolean, ...

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:



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

optional :handle_cookie_popup, union: -> { 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.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

optional :max_age_ms, Integer, nil?: true

#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:



72
 
# 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.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

optional :scroll_offset, Integer, nil?: true

#tags ⇒ Array<String>?

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

optional :tags, ContextDev::Internal::Type::ArrayOf[String]

#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).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :timeout_ms, Integer

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

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

Returns:



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

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.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

optional :wait_for_ms, Integer, nil?: true

#zdr ⇒ Symbol, ...

Set to enabled to bypass shared caches and omit request and response content from retained usage logs. Requires zero data retention to be enabled for your organization (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.

Returns:



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

optional :zdr, enum: -> { ContextDev::WebScreenshotParams::Zdr }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


108
 
# File 'sig/context_dev/models/web_screenshot_params.rbs', line 108

def to_hash: -> {