Class: Selenium::WebDriver::BiDi::Protocol::BrowsingContext Private

Relationships & Source Files
Namespace Children
Classes: `ClipRectangle`, `DownloadEndParams`, `Locator`, `Moz`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Domain`
Instance Chain: self, `Domain`
Inherits:	Selenium::WebDriver::BiDi::Protocol::Domain Object Selenium::WebDriver::BiDi::Protocol::Domain Selenium::WebDriver::BiDi::Protocol::BrowsingContext
Defined in:	rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb

Overview

See Also:

Constant Summary

AccessibilityLocator =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextaccessibilitylocator
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 141
```
Serialization::Record.define(
  type: {fixed: 'accessibility'},
  value: {wire_key: 'value', ref: 'BrowsingContext::AccessibilityLocator::Value'}
)
```
ActivateParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextactivateparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 217
```
Serialization::Record.define(context: {wire_key: 'context', primitive: 'string'})
```

BaseInfo =

Serialization::Record.define(
  children: {wire_key: 'children', nullable: true, ref: 'BrowsingContext::Info', list: true},
  client_window: {wire_key: 'clientWindow', primitive: 'string'},
  context: {wire_key: 'context', primitive: 'string'},
  original_opener: {wire_key: 'originalOpener', nullable: true, primitive: 'string'},
  url: {wire_key: 'url', primitive: 'string'},
  user_context: {wire_key: 'userContext', primitive: 'string'},
  parent: {wire_key: 'parent', required: false, nullable: true, primitive: 'string'}
)

BaseNavigationInfo =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  navigation: {wire_key: 'navigation', nullable: true, primitive: 'string'},
  timestamp: {wire_key: 'timestamp', primitive: 'integer'},
  url: {wire_key: 'url', primitive: 'string'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'}
)

BoxClipRectangle =

Serialization::Record.define(
  type: {fixed: 'box'},
  x: {wire_key: 'x', primitive: 'number'},
  y: {wire_key: 'y', primitive: 'number'},
  width: {wire_key: 'width', primitive: 'number'},
  height: {wire_key: 'height', primitive: 'number'}
)

CAPTURE_SCREENSHOT_PARAMETERS_ORIGIN =
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 74
```
{
  viewport: 'viewport',
  document: 'document'
}.freeze
```
CREATE_TYPE =
See Also:
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextcreatetype
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 64
```
{
  tab: 'tab',
  window: 'window'
}.freeze
```

CaptureScreenshotParameters =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  origin: {wire_key: 'origin', required: false, enum: 'BrowsingContext::CAPTURE_SCREENSHOT_PARAMETERS_ORIGIN'},
  format: {wire_key: 'format', required: false, ref: 'BrowsingContext::ImageFormat'},
  clip: {wire_key: 'clip', required: false, ref: 'BrowsingContext::ClipRectangle'},
  image_size: {wire_key: 'imageSize', required: false, ref: 'BrowsingContext::ImageSize'}
)

CaptureScreenshotResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextcapturescreenshotresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 283
```
Serialization::Record.define(data: {wire_key: 'data', primitive: 'string'})
```
CloseParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextcloseparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 288
```
Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  prompt_unload: {wire_key: 'promptUnload', required: false, primitive: 'boolean'}
)
```

ContextCreatedParameters =

Serialization::Record.define(
  children: {wire_key: 'children', nullable: true, ref: 'BrowsingContext::Info', list: true},
  client_window: {wire_key: 'clientWindow', primitive: 'string'},
  context: {wire_key: 'context', primitive: 'string'},
  original_opener: {wire_key: 'originalOpener', nullable: true, primitive: 'string'},
  url: {wire_key: 'url', primitive: 'string'},
  user_context: {wire_key: 'userContext', primitive: 'string'},
  parent: {wire_key: 'parent', required: false, nullable: true, primitive: 'string'},
  has_planned_navigation: {wire_key: 'hasPlannedNavigation', required: false, primitive: 'boolean'}
)

ContextLocator =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextcontextlocator
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 164
```
Serialization::Record.define(
  type: {fixed: 'context'},
  value: {wire_key: 'value', ref: 'BrowsingContext::ContextLocator::Value'}
)
```

CreateParameters =

Serialization::Record.define(
  type: {wire_key: 'type', enum: 'BrowsingContext::CREATE_TYPE'},
  reference_context: {wire_key: 'referenceContext', required: false, primitive: 'string'},
  background: {wire_key: 'background', required: false, primitive: 'boolean'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'}
)

CreateResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextcreateresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 306
```
Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'}
)
```
CssLocator =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextcsslocator
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 156
```
Serialization::Record.define(
  type: {fixed: 'css'},
  value: {wire_key: 'value', primitive: 'string'}
)
```

DownloadWillBeginParams =

Serialization::Record.define(
  download: {wire_key: 'download', primitive: 'string'},
  suggested_filename: {wire_key: 'suggestedFilename', primitive: 'string'},
  context: {wire_key: 'context', primitive: 'string'},
  navigation: {wire_key: 'navigation', nullable: true, primitive: 'string'},
  timestamp: {wire_key: 'timestamp', primitive: 'integer'},
  url: {wire_key: 'url', primitive: 'string'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'}
)

EVENTS =
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 31

{
  context_created: 'browsingContext.contextCreated',
  context_destroyed: 'browsingContext.contextDestroyed',
  dom_content_loaded: 'browsingContext.domContentLoaded',
  download_end: 'browsingContext.downloadEnd',
  download_will_begin: 'browsingContext.downloadWillBegin',
  fragment_navigated: 'browsingContext.fragmentNavigated',
  history_updated: 'browsingContext.historyUpdated',
  load: 'browsingContext.load',
  navigation_aborted: 'browsingContext.navigationAborted',
  navigation_committed: 'browsingContext.navigationCommitted',
  navigation_failed: 'browsingContext.navigationFailed',
  navigation_started: 'browsingContext.navigationStarted',
  user_prompt_closed: 'browsingContext.userPromptClosed',
  user_prompt_opened: 'browsingContext.userPromptOpened'
}.freeze

EVENT_TYPES =
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 603

{
  'browsingContext.contextCreated' => BrowsingContext::ContextCreatedParameters,
  'browsingContext.contextDestroyed' => BrowsingContext::Info,
  'browsingContext.domContentLoaded' => BrowsingContext::NavigationInfo,
  'browsingContext.downloadEnd' => BrowsingContext::DownloadEndParams,
  'browsingContext.downloadWillBegin' => BrowsingContext::DownloadWillBeginParams,
  'browsingContext.fragmentNavigated' => BrowsingContext::NavigationInfo,
  'browsingContext.historyUpdated' => BrowsingContext::HistoryUpdatedParameters,
  'browsingContext.load' => BrowsingContext::NavigationInfo,
  'browsingContext.navigationAborted' => BrowsingContext::NavigationInfo,
  'browsingContext.navigationCommitted' => BrowsingContext::NavigationInfo,
  'browsingContext.navigationFailed' => BrowsingContext::NavigationInfo,
  'browsingContext.navigationStarted' => BrowsingContext::NavigationInfo,
  'browsingContext.userPromptClosed' => BrowsingContext::UserPromptClosedParameters,
  'browsingContext.userPromptOpened' => BrowsingContext::UserPromptOpenedParameters
}.freeze

ElementClipRectangle =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextelementcliprectangle
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 264
```
Serialization::Record.define(
  type: {fixed: 'element'},
  element: {wire_key: 'element', ref: 'Script::SharedReference'}
)
```
GetTreeParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextgettreeparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 314
```
Serialization::Record.define(
  max_depth: {wire_key: 'maxDepth', required: false, primitive: 'integer'},
  root: {wire_key: 'root', required: false, primitive: 'string'},
  extensible: true
)
```
GetTreeResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextgettreeresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 323
```
Serialization::Record.define(
  contexts: {wire_key: 'contexts', ref: 'BrowsingContext::Info', list: true}
)
```
HandleUserPromptParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontexthandleuserpromptparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 330
```
Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  accept: {wire_key: 'accept', required: false, primitive: 'boolean'},
  user_text: {wire_key: 'userText', required: false, primitive: 'string'}
)
```

HistoryUpdatedParameters =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  timestamp: {wire_key: 'timestamp', primitive: 'integer'},
  url: {wire_key: 'url', primitive: 'string'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'}
)

INNER_TEXT_LOCATOR_MATCH_TYPE =
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 69
```
{
  full: 'full',
  partial: 'partial'
}.freeze
```
ImageFormat =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextimageformat
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 233
```
Serialization::Record.define(
  type: {wire_key: 'type', primitive: 'string'},
  quality: {wire_key: 'quality', required: false, primitive: 'number'}
)
```
ImageSize =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextimagesize
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 241
```
Serialization::Record.define(
  max_width: {wire_key: 'maxWidth', required: false, primitive: 'integer'},
  max_height: {wire_key: 'maxHeight', required: false, primitive: 'integer'}
)
```

Info =

Serialization::Record.define(
  children: {wire_key: 'children', nullable: true, ref: 'BrowsingContext::Info', list: true},
  client_window: {wire_key: 'clientWindow', primitive: 'string'},
  context: {wire_key: 'context', primitive: 'string'},
  original_opener: {wire_key: 'originalOpener', nullable: true, primitive: 'string'},
  url: {wire_key: 'url', primitive: 'string'},
  user_context: {wire_key: 'userContext', primitive: 'string'},
  parent: {wire_key: 'parent', required: false, nullable: true, primitive: 'string'},
  extensible: true
)

InnerTextLocator =

Serialization::Record.define(
  type: {fixed: 'innerText'},
  value: {wire_key: 'value', primitive: 'string'},
  ignore_case: {wire_key: 'ignoreCase', required: false, primitive: 'boolean'},
  match_type: {wire_key: 'matchType', required: false, enum: 'BrowsingContext::INNER_TEXT_LOCATOR_MATCH_TYPE'},
  max_depth: {wire_key: 'maxDepth', required: false, primitive: 'integer'}
)

LocateNodesParameters =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  locator: {wire_key: 'locator', ref: 'BrowsingContext::Locator'},
  max_node_count: {wire_key: 'maxNodeCount', required: false, primitive: 'integer'},
  serialization_options: {
    wire_key: 'serializationOptions',
    required: false,
    ref: 'Script::SerializationOptions'
  },
  start_nodes: {wire_key: 'startNodes', required: false, ref: 'Script::SharedReference', list: true}
)

LocateNodesResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextlocatenodesresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 354
```
Serialization::Record.define(
  nodes: {wire_key: 'nodes', ref: 'Script::NodeRemoteValue', list: true}
)
```

MediaTrackConstraints =

Serialization::Record.define(
  width: {wire_key: 'width', required: false, primitive: 'integer'},
  height: {wire_key: 'height', required: false, primitive: 'integer'},
  frame_rate: {wire_key: 'frameRate', required: false, primitive: 'integer'}
)

NavigateParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextnavigateparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 361
```
Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  url: {wire_key: 'url', primitive: 'string'},
  wait: {wire_key: 'wait', required: false, enum: 'BrowsingContext::READINESS_STATE'}
)
```
NavigateResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextnavigateresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 370
```
Serialization::Record.define(
  navigation: {wire_key: 'navigation', nullable: true, primitive: 'string'},
  url: {wire_key: 'url', primitive: 'string'}
)
```

NavigationInfo =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  navigation: {wire_key: 'navigation', nullable: true, primitive: 'string'},
  timestamp: {wire_key: 'timestamp', primitive: 'integer'},
  url: {wire_key: 'url', primitive: 'string'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'}
)

PRINT_PARAMETERS_ORIENTATION =
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 79
```
{
  portrait: 'portrait',
  landscape: 'landscape'
}.freeze
```

PrintMarginParameters =

Serialization::Record.define(
  bottom: {wire_key: 'bottom', required: false, primitive: 'number'},
  left: {wire_key: 'left', required: false, primitive: 'number'},
  right: {wire_key: 'right', required: false, primitive: 'number'},
  top: {wire_key: 'top', required: false, primitive: 'number'}
)

PrintPageParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextprintpageparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 406
```
Serialization::Record.define(
  height: {wire_key: 'height', required: false, primitive: 'number'},
  width: {wire_key: 'width', required: false, primitive: 'number'}
)
```

PrintParameters =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  background: {wire_key: 'background', required: false, primitive: 'boolean'},
  margin: {wire_key: 'margin', required: false, ref: 'BrowsingContext::PrintMarginParameters'},
  orientation: {
    wire_key: 'orientation',
    required: false,
    enum: 'BrowsingContext::PRINT_PARAMETERS_ORIENTATION'
  },
  page: {wire_key: 'page', required: false, ref: 'BrowsingContext::PrintPageParameters'},
  page_ranges: {wire_key: 'pageRanges', required: false, list: true},
  scale: {wire_key: 'scale', required: false, primitive: 'number'},
  shrink_to_fit: {wire_key: 'shrinkToFit', required: false, primitive: 'boolean'}
)

PrintResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextprintresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 414
```
Serialization::Record.define(data: {wire_key: 'data', primitive: 'string'})
```
READINESS_STATE =
See Also:
- https://w3c.github.io/webdriver-bidi/#type-browsingContext-ReadinessState
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 49
```
{
  none: 'none',
  interactive: 'interactive',
  complete: 'complete'
}.freeze
```

ReloadParameters =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  ignore_cache: {wire_key: 'ignoreCache', required: false, primitive: 'boolean'},
  wait: {wire_key: 'wait', required: false, enum: 'BrowsingContext::READINESS_STATE'}
)

SetBypassCSPParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextsetbypasscspparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 428
```
Serialization::Record.define(
  bypass: {wire_key: 'bypass', nullable: true, const: true},
  contexts: {wire_key: 'contexts', required: false, list: true},
  user_contexts: {wire_key: 'userContexts', required: false, list: true}
)
```

SetViewportParameters =

Serialization::Record.define(
  context: {wire_key: 'context', required: false, primitive: 'string'},
  viewport: {wire_key: 'viewport', required: false, nullable: true, ref: 'BrowsingContext::Viewport'},
  device_pixel_ratio: {wire_key: 'devicePixelRatio', required: false, nullable: true, primitive: 'number'},
  user_contexts: {wire_key: 'userContexts', required: false, list: true}
)

StartScreencastParameters =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  destination_folder: {wire_key: 'destinationFolder', required: false, primitive: 'string'},
  mime_type: {wire_key: 'mimeType', required: false, primitive: 'string'},
  video: {wire_key: 'video', required: false, ref: 'BrowsingContext::MediaTrackConstraints'},
  audio: {wire_key: 'audio', required: false, primitive: 'boolean'}
)

StartScreencastResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextstartscreencastresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 475
```
Serialization::Record.define(
  screencast: {wire_key: 'screencast', primitive: 'string'},
  path: {wire_key: 'path', primitive: 'string'}
)
```
StopScreencastParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextstopscreencastparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 483
```
Serialization::Record.define(
  screencast: {wire_key: 'screencast', primitive: 'string'}
)
```
StopScreencastResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextstopscreencastresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 490
```
Serialization::Record.define(
  path: {wire_key: 'path', primitive: 'string'},
  error: {wire_key: 'error', required: false, primitive: 'string'}
)
```
TraverseHistoryParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontexttraversehistoryparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 498
```
Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  delta: {wire_key: 'delta', primitive: 'integer'}
)
```
USER_PROMPT_TYPE =
See Also:
- https://w3c.github.io/webdriver-bidi/#type-browsingContext-UserPromptType
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 56
```
{
  alert: 'alert',
  beforeunload: 'beforeunload',
  confirm: 'confirm',
  prompt: 'prompt'
}.freeze
```

UserPromptClosedParameters =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  accepted: {wire_key: 'accepted', primitive: 'boolean'},
  type: {wire_key: 'type', enum: 'BrowsingContext::USER_PROMPT_TYPE'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'},
  user_text: {wire_key: 'userText', required: false, primitive: 'string'}
)

UserPromptOpenedParameters =

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  handler: {wire_key: 'handler', enum: 'Session::USER_PROMPT_HANDLER_TYPE'},
  message: {wire_key: 'message', primitive: 'string'},
  type: {wire_key: 'type', enum: 'BrowsingContext::USER_PROMPT_TYPE'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'},
  default_value: {wire_key: 'defaultValue', required: false, primitive: 'string'}
)

Viewport =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextviewport
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 447
```
Serialization::Record.define(
  width: {wire_key: 'width', primitive: 'integer'},
  height: {wire_key: 'height', primitive: 'integer'}
)
```
XPathLocator =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-browsingcontextxpathlocator
# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 187
```
Serialization::Record.define(
  type: {fixed: 'xpath'},
  value: {wire_key: 'value', primitive: 'string'}
)
```

Class Method Summary

`Domain` - Inherited

.new

Instance Method Summary

#accessibility_locator Internal use only
#accessibility_locator_value Internal use only
#activate(context:) Internal use only
#box_clip_rectangle Internal use only
#capture_screenshot(context:, origin: Serialization::UNSET, format: Serialization::UNSET, clip: Serialization::UNSET, image_size: Serialization::UNSET) Internal use only
#clip_rectangle Internal use only
#close(context:, prompt_unload: Serialization::UNSET) Internal use only
#context_locator Internal use only
#context_locator_value Internal use only
#create(type:, reference_context: Serialization::UNSET, background: Serialization::UNSET, user_context: Serialization::UNSET) Internal use only
#css_locator Internal use only
#element_clip_rectangle Internal use only
#get_tree(max_depth: Serialization::UNSET, root: Serialization::UNSET) Internal use only
#handle_user_prompt(context:, accept: Serialization::UNSET, user_text: Serialization::UNSET) Internal use only
#image_format Internal use only
#image_size Internal use only
#inner_text_locator Internal use only
#locate_nodes(context:, locator:, max_node_count: Serialization::UNSET, serialization_options: Serialization::UNSET, start_nodes: Serialization::UNSET) Internal use only
#locator Internal use only
#media_track_constraints Internal use only
#moz Internal use only
#navigate(context:, url:, wait: Serialization::UNSET) Internal use only
#print(context:, background: Serialization::UNSET, margin: Serialization::UNSET, orientation: Serialization::UNSET, page: Serialization::UNSET, page_ranges: Serialization::UNSET, scale: Serialization::UNSET, shrink_to_fit: Serialization::UNSET) Internal use only
#print_margin_parameters Internal use only
#print_page_parameters Internal use only
#reload(context:, ignore_cache: Serialization::UNSET, wait: Serialization::UNSET) Internal use only
#set_bypass_csp(bypass:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_viewport(context: Serialization::UNSET, viewport: Serialization::UNSET, device_pixel_ratio: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#start_screencast(context:, destination_folder: Serialization::UNSET, mime_type: Serialization::UNSET, video: Serialization::UNSET, audio: Serialization::UNSET) Internal use only
#stop_screencast(screencast:) Internal use only
#traverse_history(context:, delta:) Internal use only
#viewport Internal use only
#x_path_locator Internal use only

`Domain` - Inherited

#connection	The connection this domain runs over, so a generated vendor accessor can build its sibling variant (`Moz.new(connection)`) — construction stays connection-based.
#execute

Constructor Details

This class inherits a constructor from Selenium::WebDriver::BiDi::Protocol::Domain

Instance Method Details

#accessibility_locator

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 621


def accessibility_locator(**) = AccessibilityLocator.new(**)

#accessibility_locator_value

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 635


def accessibility_locator_value(**) = AccessibilityLocator::Value.new(**)

#activate(context:)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 642


def activate(context:)
  params = ActivateParameters.new(context: context)
  execute(cmd: 'browsingContext.activate', params: params)
end

#box_clip_rectangle

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 630


def box_clip_rectangle(**) = BoxClipRectangle.new(**)

#capture_screenshot(context:, origin: Serialization::UNSET, format: Serialization::UNSET, clip: Serialization::UNSET, image_size: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 650


def capture_screenshot(
  context:,
  origin: Serialization::UNSET,
  format: Serialization::UNSET,
  clip: Serialization::UNSET,
  image_size: Serialization::UNSET
)
  Serialization.validate!('origin', origin, BrowsingContext::CAPTURE_SCREENSHOT_PARAMETERS_ORIGIN)
  params = CaptureScreenshotParameters.new(
    context: context,
    origin: origin,
    format: format,
    clip: clip,
    image_size: image_size
  )
  execute(
    cmd: 'browsingContext.captureScreenshot',
    params: params,
    result: BrowsingContext::CaptureScreenshotResult
  )
end

#clip_rectangle

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 628


def clip_rectangle = ClipRectangle

#close(context:, prompt_unload: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 675


def close(context:, prompt_unload: Serialization::UNSET)
  params = CloseParameters.new(context: context, prompt_unload: prompt_unload)
  execute(cmd: 'browsingContext.close', params: params)
end

#context_locator

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 623


def context_locator(**) = ContextLocator.new(**)

#context_locator_value

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 636


def context_locator_value(**) = ContextLocator::Value.new(**)

#create(type:, reference_context: Serialization::UNSET, background: Serialization::UNSET, user_context: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 683


def create(
  type:,
  reference_context: Serialization::UNSET,
  background: Serialization::UNSET,
  user_context: Serialization::UNSET
)
  Serialization.validate!('type', type, BrowsingContext::CREATE_TYPE)
  params = CreateParameters.new(
    type: type,
    reference_context: reference_context,
    background: background,
    user_context: user_context
  )
  execute(cmd: 'browsingContext.create', params: params, result: BrowsingContext::CreateResult)
end

#css_locator

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 622


def css_locator(**) = CssLocator.new(**)

#element_clip_rectangle

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 629


def element_clip_rectangle(**) = ElementClipRectangle.new(**)

#get_tree(max_depth: Serialization::UNSET, root: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 702


def get_tree(max_depth: Serialization::UNSET, root: Serialization::UNSET)
  params = GetTreeParameters.new(max_depth: max_depth, root: root)
  execute(cmd: 'browsingContext.getTree', params: params, result: BrowsingContext::GetTreeResult)
end

#handle_user_prompt(context:, accept: Serialization::UNSET, user_text: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 710


def handle_user_prompt(context:, accept: Serialization::UNSET, user_text: Serialization::UNSET)
  params = HandleUserPromptParameters.new(context: context, accept: accept, user_text: user_text)
  execute(cmd: 'browsingContext.handleUserPrompt', params: params)
end

#image_format

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 626


def image_format(**) = ImageFormat.new(**)

#image_size

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 627


def image_size(**) = ImageSize.new(**)

#inner_text_locator

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 624


def inner_text_locator(**) = InnerTextLocator.new(**)

#locate_nodes(context:, locator:, max_node_count: Serialization::UNSET, serialization_options: Serialization::UNSET, start_nodes: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 718


def locate_nodes(
  context:,
  locator:,
  max_node_count: Serialization::UNSET,
  serialization_options: Serialization::UNSET,
  start_nodes: Serialization::UNSET
)
  params = LocateNodesParameters.new(
    context: context,
    locator: locator,
    max_node_count: max_node_count,
    serialization_options: serialization_options,
    start_nodes: start_nodes
  )
  execute(cmd: 'browsingContext.locateNodes', params: params, result: BrowsingContext::LocateNodesResult)
end

#locator

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 620


def locator = Locator

#media_track_constraints

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 634


def media_track_constraints(**) = MediaTrackConstraints.new(**)

#moz

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 637


def moz = Moz.new(connection)

#navigate(context:, url:, wait: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 738


def navigate(context:, url:, wait: Serialization::UNSET)
  Serialization.validate!('wait', wait, BrowsingContext::READINESS_STATE)
  params = NavigateParameters.new(context: context, url: url, wait: wait)
  execute(cmd: 'browsingContext.navigate', params: params, result: BrowsingContext::NavigateResult)
end

#print(context:, background: Serialization::UNSET, margin: Serialization::UNSET, orientation: Serialization::UNSET, page: Serialization::UNSET, page_ranges: Serialization::UNSET, scale: Serialization::UNSET, shrink_to_fit: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 747


def print(
  context:,
  background: Serialization::UNSET,
  margin: Serialization::UNSET,
  orientation: Serialization::UNSET,
  page: Serialization::UNSET,
  page_ranges: Serialization::UNSET,
  scale: Serialization::UNSET,
  shrink_to_fit: Serialization::UNSET
)
  Serialization.validate!('orientation', orientation, BrowsingContext::PRINT_PARAMETERS_ORIENTATION)
  params = PrintParameters.new(
    context: context,
    background: background,
    margin: margin,
    orientation: orientation,
    page: page,
    page_ranges: page_ranges,
    scale: scale,
    shrink_to_fit: shrink_to_fit
  )
  execute(cmd: 'browsingContext.print', params: params, result: BrowsingContext::PrintResult)
end

#print_margin_parameters

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 631


def print_margin_parameters(**) = PrintMarginParameters.new(**)

#print_page_parameters

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 632


def print_page_parameters(**) = PrintPageParameters.new(**)

#reload(context:, ignore_cache: Serialization::UNSET, wait: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 774


def reload(context:, ignore_cache: Serialization::UNSET, wait: Serialization::UNSET)
  Serialization.validate!('wait', wait, BrowsingContext::READINESS_STATE)
  params = ReloadParameters.new(context: context, ignore_cache: ignore_cache, wait: wait)
  execute(cmd: 'browsingContext.reload', params: params, result: BrowsingContext::NavigateResult)
end

#set_bypass_csp(bypass:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 783


def set_bypass_csp(bypass:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)
  params = SetBypassCSPParameters.new(bypass: bypass, contexts: contexts, user_contexts: user_contexts)
  execute(cmd: 'browsingContext.setBypassCSP', params: params)
end

#set_viewport(context: Serialization::UNSET, viewport: Serialization::UNSET, device_pixel_ratio: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 791


def set_viewport(
  context: Serialization::UNSET,
  viewport: Serialization::UNSET,
  device_pixel_ratio: Serialization::UNSET,
  user_contexts: Serialization::UNSET
)
  params = SetViewportParameters.new(
    context: context,
    viewport: viewport,
    device_pixel_ratio: device_pixel_ratio,
    user_contexts: user_contexts
  )
  execute(cmd: 'browsingContext.setViewport', params: params)
end

#start_screencast(context:, destination_folder: Serialization::UNSET, mime_type: Serialization::UNSET, video: Serialization::UNSET, audio: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 809


def start_screencast(
  context:,
  destination_folder: Serialization::UNSET,
  mime_type: Serialization::UNSET,
  video: Serialization::UNSET,
  audio: Serialization::UNSET
)
  params = StartScreencastParameters.new(
    context: context,
    destination_folder: destination_folder,
    mime_type: mime_type,
    video: video,
    audio: audio
  )
  execute(
    cmd: 'browsingContext.startScreencast',
    params: params,
    result: BrowsingContext::StartScreencastResult
  )
end

#stop_screencast(screencast:)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 833


def stop_screencast(screencast:)
  params = StopScreencastParameters.new(screencast: screencast)
  execute(
    cmd: 'browsingContext.stopScreencast',
    params: params,
    result: BrowsingContext::StopScreencastResult
  )
end

#traverse_history(context:, delta:)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 845


def traverse_history(context:, delta:)
  params = TraverseHistoryParameters.new(context: context, delta: delta)
  execute(cmd: 'browsingContext.traverseHistory', params: params)
end

#viewport

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 633


def viewport(**) = Viewport.new(**)

#x_path_locator

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/browsing_context.rb', line 625


def x_path_locator(**) = XPathLocator.new(**)

Class: Selenium::WebDriver::BiDi::Protocol::BrowsingContext Private

Overview

Constant Summary

Class Method Summary

Domain - Inherited

Instance Method Summary

Domain - Inherited

Constructor Details

Instance Method Details

#accessibility_locator

#accessibility_locator_value

#activate(context:)

#box_clip_rectangle

#capture_screenshot(context:, origin: Serialization::UNSET, format: Serialization::UNSET, clip: Serialization::UNSET, image_size: Serialization::UNSET)

#clip_rectangle

#close(context:, prompt_unload: Serialization::UNSET)

#context_locator

#context_locator_value

#create(type:, reference_context: Serialization::UNSET, background: Serialization::UNSET, user_context: Serialization::UNSET)

#css_locator

#element_clip_rectangle

#get_tree(max_depth: Serialization::UNSET, root: Serialization::UNSET)

#handle_user_prompt(context:, accept: Serialization::UNSET, user_text: Serialization::UNSET)

#image_format

#image_size

#inner_text_locator

#locate_nodes(context:, locator:, max_node_count: Serialization::UNSET, serialization_options: Serialization::UNSET, start_nodes: Serialization::UNSET)

#locator

#media_track_constraints

#moz

#navigate(context:, url:, wait: Serialization::UNSET)

#print(context:, background: Serialization::UNSET, margin: Serialization::UNSET, orientation: Serialization::UNSET, page: Serialization::UNSET, page_ranges: Serialization::UNSET, scale: Serialization::UNSET, shrink_to_fit: Serialization::UNSET)

#print_margin_parameters

#print_page_parameters

#reload(context:, ignore_cache: Serialization::UNSET, wait: Serialization::UNSET)

#set_bypass_csp(bypass:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_viewport(context: Serialization::UNSET, viewport: Serialization::UNSET, device_pixel_ratio: Serialization::UNSET, user_contexts: Serialization::UNSET)

#start_screencast(context:, destination_folder: Serialization::UNSET, mime_type: Serialization::UNSET, video: Serialization::UNSET, audio: Serialization::UNSET)

#stop_screencast(screencast:)

#traverse_history(context:, delta:)

#viewport

#x_path_locator

`Domain` - Inherited

`Domain` - Inherited