Class: Selenium::WebDriver::BiDi::Protocol::Browser Private

Inherits:

Domain

• Object
• Domain
• Selenium::WebDriver::BiDi::Protocol::Browser

Defined in:

lib/selenium/webdriver/bidi/protocol/browser.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#module-browser

Defined Under Namespace

Classes: DownloadBehavior, SetClientWindowStateParameters

Constant Summary

CLIENT_WINDOW_INFO_STATE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

{
  fullscreen: 'fullscreen',
  maximized: 'maximized',
  minimized: 'minimized',
  normal: 'normal'
}.freeze

CLIENT_WINDOW_NAMED_STATE_STATE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

{
  fullscreen: 'fullscreen',
  maximized: 'maximized',
  minimized: 'minimized'
}.freeze

ClientWindowInfo =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#type-browser-ClientWindowInfo

Serialization::Record.define(
  active: {wire_key: 'active', primitive: 'boolean'},
  client_window: {wire_key: 'clientWindow', primitive: 'string'},
  height: {wire_key: 'height', primitive: 'integer'},
  state: {wire_key: 'state', enum: 'Browser::CLIENT_WINDOW_INFO_STATE'},
  width: {wire_key: 'width', primitive: 'integer'},
  x: {wire_key: 'x', primitive: 'integer'},
  y: {wire_key: 'y', primitive: 'integer'}
)

UserContextInfo =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#type-browser-UserContextInfo

Serialization::Record.define(user_context: {wire_key: 'userContext', primitive: 'string'})

CreateUserContextParameters =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-browsercreateusercontextparameters

Serialization::Record.define(
  accept_insecure_certs: {wire_key: 'acceptInsecureCerts', required: false, primitive: 'boolean'},
  proxy: {wire_key: 'proxy', required: false, ref: 'Session::ProxyConfiguration'},
  unhandled_prompt_behavior: {
    wire_key: 'unhandledPromptBehavior',
    required: false,
    ref: 'Session::UserPromptHandler'
  }
)

GetClientWindowsResult =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-browsergetclientwindowsresult

Serialization::Record.define(
  client_windows: {wire_key: 'clientWindows', ref: 'Browser::ClientWindowInfo', list: true}
)

GetUserContextsResult =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-browsergetusercontextsresult

Serialization::Record.define(
  user_contexts: {wire_key: 'userContexts', ref: 'Browser::UserContextInfo', list: true}
)

RemoveUserContextParameters =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-browserremoveusercontextparameters

Serialization::Record.define(
  user_context: {wire_key: 'userContext', primitive: 'string'}
)

SetDownloadBehaviorParameters =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-browsersetdownloadbehaviorparameters

Serialization::Record.define(
  download_behavior: {wire_key: 'downloadBehavior', nullable: true, ref: 'Browser::DownloadBehavior'},
  user_contexts: {wire_key: 'userContexts', required: false, list: true}
)

Instance Method Summary

• #close ⇒ Object private
• #create_user_context(accept_insecure_certs: Serialization::UNSET, proxy: Serialization::UNSET, unhandled_prompt_behavior: Serialization::UNSET) ⇒ Object private
• #download_behavior ⇒ Object private
• #get_client_windows ⇒ Object private
• #get_user_contexts ⇒ Object private
• #remove_user_context(user_context:) ⇒ Object private
• #set_client_window_state(client_window:, state:, width: Serialization::UNSET, height: Serialization::UNSET, x: Serialization::UNSET, y: Serialization::UNSET) ⇒ Object private
• #set_download_behavior(download_behavior:, user_contexts: Serialization::UNSET) ⇒ Object private

Methods inherited from Domain

#initialize

Constructor Details

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

Instance Method Details

#close ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-browser-close

# File 'lib/selenium/webdriver/bidi/protocol/browser.rb', line 167

def close
  execute(cmd: 'browser.close')
end

#create_user_context(accept_insecure_certs: Serialization::UNSET, proxy: Serialization::UNSET, unhandled_prompt_behavior: Serialization::UNSET) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-browser-createUserContext

# File 'lib/selenium/webdriver/bidi/protocol/browser.rb', line 174

def create_user_context(
  accept_insecure_certs: Serialization::UNSET,
  proxy: Serialization::UNSET,
  unhandled_prompt_behavior: Serialization::UNSET
)
  params = CreateUserContextParameters.new(
    accept_insecure_certs: accept_insecure_certs,
    proxy: proxy,
    unhandled_prompt_behavior: unhandled_prompt_behavior
  )
  execute(cmd: 'browser.createUserContext', params: params, result: Browser::UserContextInfo)
end

#download_behavior ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/bidi/protocol/browser.rb', line 162

def download_behavior = DownloadBehavior

#get_client_windows ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-browser-getClientWindows

# File 'lib/selenium/webdriver/bidi/protocol/browser.rb', line 190

def get_client_windows
  execute(cmd: 'browser.getClientWindows', result: Browser::GetClientWindowsResult)
end

#get_user_contexts ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-browser-getUserContexts

# File 'lib/selenium/webdriver/bidi/protocol/browser.rb', line 197

def get_user_contexts
  execute(cmd: 'browser.getUserContexts', result: Browser::GetUserContextsResult)
end

#remove_user_context(user_context:) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-browser-removeUserContext

# File 'lib/selenium/webdriver/bidi/protocol/browser.rb', line 204

def remove_user_context(user_context:)
  params = RemoveUserContextParameters.new(user_context: user_context)
  execute(cmd: 'browser.removeUserContext', params: params)
end

#set_client_window_state(client_window:, state:, width: Serialization::UNSET, height: Serialization::UNSET, x: Serialization::UNSET, y: Serialization::UNSET) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-browser-setClientWindowState

# File 'lib/selenium/webdriver/bidi/protocol/browser.rb', line 212

def set_client_window_state(
  client_window:,
  state:,
  width: Serialization::UNSET,
  height: Serialization::UNSET,
  x: Serialization::UNSET,
  y: Serialization::UNSET
)
  Serialization.validate!(
    'state',
    state,
    {normal: 'normal', fullscreen: 'fullscreen', maximized: 'maximized', minimized: 'minimized'}
  )
  params = SetClientWindowStateParameters.build(
    client_window: client_window,
    state: state,
    width: width,
    height: height,
    x: x,
    y: y
  )
  execute(cmd: 'browser.setClientWindowState', params: params, result: Browser::ClientWindowInfo)
end

#set_download_behavior(download_behavior:, user_contexts: Serialization::UNSET) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-browser-setDownloadBehavior

# File 'lib/selenium/webdriver/bidi/protocol/browser.rb', line 239

def set_download_behavior(download_behavior:, user_contexts: Serialization::UNSET)
  params = SetDownloadBehaviorParameters.new(
    download_behavior: download_behavior,
    user_contexts: user_contexts
  )
  execute(cmd: 'browser.setDownloadBehavior', params: params)
end