Class: Selenium::WebDriver::BiDi::Protocol::Session Private

Relationships & Source Files
Namespace Children
Classes: `ProxyConfiguration`, `UnsubscribeParameters`
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::Session
Defined in:	rb/lib/selenium/webdriver/bidi/protocol/session.rb

Overview

See Also:

Constant Summary

AutodetectProxyConfiguration =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessionautodetectproxyconfiguration
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 128
```
Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'autodetect'},
  extensible: true
)
```

CAPABILITY_REQUEST_FIREFOX_OPTIONS_LEVEL =
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 38

{
  trace: 'trace',
  debug: 'debug',
  config: 'config',
  info: 'info',
  warn: 'warn',
  error: 'error',
  fatal: 'fatal'
}.freeze

CapabilitiesRequest =

Serialization::Record.define(
  always_match: {wire_key: 'alwaysMatch', required: false, ref: 'Session::CapabilityRequest'},
  first_match: {wire_key: 'firstMatch', required: false, ref: 'Session::CapabilityRequest', list: true}
)

CapabilityRequest =

Serialization::Record.define(
  accept_insecure_certs: {wire_key: 'acceptInsecureCerts', required: false, primitive: 'boolean'},
  browser_name: {wire_key: 'browserName', required: false, primitive: 'string'},
  browser_version: {wire_key: 'browserVersion', required: false, primitive: 'string'},
  platform_name: {wire_key: 'platformName', required: false, primitive: 'string'},
  proxy: {wire_key: 'proxy', required: false, ref: 'Session::ProxyConfiguration'},
  unhandled_prompt_behavior: {
    wire_key: 'unhandledPromptBehavior',
    required: false,
    ref: 'Session::UserPromptHandler'
  },
  moz_firefox_options: {
    wire_key: 'moz:firefoxOptions',
    required: false,
    ref: 'Session::CapabilityRequestFirefoxOptions'
  },
  extensible: true
)

CapabilityRequestFirefoxOptions =

See Also:

https://www.selenium.dev/documentation/warnings/bidi-implementation/

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 255

Serialization::Record.define(
  android_package: {wire_key: 'androidPackage', required: false, primitive: 'string'},
  android_activity: {wire_key: 'androidActivity', required: false, primitive: 'string'},
  android_device_serial: {wire_key: 'androidDeviceSerial', required: false, primitive: 'string'},
  android_intent_arguments: {
    wire_key: 'androidIntentArguments',
    required: false,
    list: true,
    primitive: 'string'
  },
  args: {wire_key: 'args', required: false, list: true, primitive: 'string'},
  binary: {wire_key: 'binary', required: false, primitive: 'string'},
  env: {wire_key: 'env', required: false, map: 'string'},
  log: {wire_key: 'log', required: false, ref: 'Session::CapabilityRequestFirefoxOptions::Log'},
  prefs: {
    wire_key: 'prefs',
    required: false,
    map: %w[string boolean integer],
    min: -9_007_199_254_740_991,
    max: 9_007_199_254_740_991
  },
  profile: {wire_key: 'profile', required: false, primitive: 'string'}
)

CapabilityResponse =

Serialization::Record.define(
  accept_insecure_certs: {wire_key: 'acceptInsecureCerts', primitive: 'boolean'},
  browser_name: {wire_key: 'browserName', primitive: 'string'},
  browser_version: {wire_key: 'browserVersion', primitive: 'string'},
  platform_name: {wire_key: 'platformName', primitive: 'string'},
  set_window_rect: {wire_key: 'setWindowRect', primitive: 'boolean'},
  user_agent: {wire_key: 'userAgent', primitive: 'string'},
  proxy: {wire_key: 'proxy', required: false, ref: 'Session::ProxyConfiguration'},
  unhandled_prompt_behavior: {
    wire_key: 'unhandledPromptBehavior',
    required: false,
    ref: 'Session::UserPromptHandler'
  },
  web_socket_url: {wire_key: 'webSocketUrl', required: false, primitive: 'string'},
  extensible: true
)

DirectProxyConfiguration =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessiondirectproxyconfiguration
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 136
```
Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'direct'},
  extensible: true
)
```

ManualProxyConfiguration =

Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'manual'},
  http_proxy: {wire_key: 'httpProxy', required: false, primitive: 'string'},
  ssl_proxy: {wire_key: 'sslProxy', required: false, primitive: 'string'},
  socks_proxy: {wire_key: 'socksProxy', primitive: 'string'},
  socks_version: {wire_key: 'socksVersion', primitive: 'integer', min: 0, max: 255},
  no_proxy: {wire_key: 'noProxy', required: false, list: true, primitive: 'string'},
  extensible: true
)

NewParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessionnewparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 225
```
Serialization::Record.define(
  capabilities: {wire_key: 'capabilities', ref: 'Session::CapabilitiesRequest'}
)
```
NewResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessionnewresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 232
```
Serialization::Record.define(
  session_id: {wire_key: 'sessionId', primitive: 'string'},
  capabilities: {wire_key: 'capabilities', ref: 'Session::CapabilityResponse'}
)
```
PacProxyConfiguration =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessionpacproxyconfiguration
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 165
```
Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'pac'},
  proxy_autoconfig_url: {wire_key: 'proxyAutoconfigUrl', primitive: 'string'},
  extensible: true
)
```
SocksProxyConfiguration =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessionsocksproxyconfiguration
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 157
```
Serialization::Record.define(
  socks_proxy: {wire_key: 'socksProxy', primitive: 'string'},
  socks_version: {wire_key: 'socksVersion', primitive: 'integer', min: 0, max: 255}
)
```
StatusResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessionstatusresult
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 217
```
Serialization::Record.define(
  ready: {wire_key: 'ready', primitive: 'boolean'},
  message: {wire_key: 'message', primitive: 'string'}
)
```

SubscribeParameters =

Serialization::Record.define(
  events: {wire_key: 'events', list: true, primitive: 'string'},
  contexts: {wire_key: 'contexts', required: false, list: true, primitive: 'string'},
  user_contexts: {wire_key: 'userContexts', required: false, list: true, primitive: 'string'}
)

SubscribeResult =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessionsubscriberesult
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 240
```
Serialization::Record.define(subscription: {wire_key: 'subscription', primitive: 'string'})
```
SystemProxyConfiguration =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessionsystemproxyconfiguration
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 174
```
Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'system'},
  extensible: true
)
```
USER_PROMPT_HANDLER_TYPE =
See Also:
- https://w3c.github.io/webdriver-bidi/#type-session-UserPromptHandlerType
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 32
```
{
  accept: 'accept',
  dismiss: 'dismiss',
  ignore: 'ignore'
}.freeze
```
UnsubscribeByAttributesRequest =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#type-session-UnsubscribeByAttributesRequest
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 210
```
Serialization::Record.define(
  events: {wire_key: 'events', list: true, primitive: 'string'}
)
```
UnsubscribeByIDRequest =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#type-session-UnsubscribeByIDRequest
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 203
```
Serialization::Record.define(
  subscriptions: {wire_key: 'subscriptions', list: true, primitive: 'string'}
)
```

UserPromptHandler =

Serialization::Record.define(
  alert: {wire_key: 'alert', required: false, enum: 'Session::USER_PROMPT_HANDLER_TYPE'},
  before_unload: {wire_key: 'beforeUnload', required: false, enum: 'Session::USER_PROMPT_HANDLER_TYPE'},
  confirm: {wire_key: 'confirm', required: false, enum: 'Session::USER_PROMPT_HANDLER_TYPE'},
  default: {wire_key: 'default', required: false, enum: 'Session::USER_PROMPT_HANDLER_TYPE'},
  file: {wire_key: 'file', required: false, enum: 'Session::USER_PROMPT_HANDLER_TYPE'},
  prompt: {wire_key: 'prompt', required: false, enum: 'Session::USER_PROMPT_HANDLER_TYPE'}
)

Class Method Summary

`Domain` - Inherited

.new

Instance Method Summary

#autodetect_proxy_configuration Internal use only
#capabilities_request Internal use only
#capability_request Internal use only
#capability_request_firefox_options Internal use only
#capability_request_firefox_options_log Internal use only
#direct_proxy_configuration Internal use only
#end_ Internal use only
#manual_proxy_configuration Internal use only
#new(capabilities:) Internal use only
#pac_proxy_configuration Internal use only
#proxy_configuration Internal use only
#status Internal use only
#subscribe(events:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#system_proxy_configuration Internal use only
#unsubscribe(events: Serialization::UNSET, subscriptions: Serialization::UNSET) Internal use only
#unsubscribe_by_attributes_request Internal use only
#unsubscribe_by_id_request Internal use only
#user_prompt_handler 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

#autodetect_proxy_configuration

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 288


def autodetect_proxy_configuration(**) = AutodetectProxyConfiguration.new(**)

#capabilities_request

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 285


def capabilities_request(**) = CapabilitiesRequest.new(**)

#capability_request

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 286


def capability_request(**) = CapabilityRequest.new(**)

#capability_request_firefox_options

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 296


def capability_request_firefox_options(**) = CapabilityRequestFirefoxOptions.new(**)

#capability_request_firefox_options_log

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 297


def capability_request_firefox_options_log(**) = CapabilityRequestFirefoxOptions::Log.new(**)

#direct_proxy_configuration

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 289


def direct_proxy_configuration(**) = DirectProxyConfiguration.new(**)

#end_

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 302


def end_
  execute(cmd: 'session.end')
end

#manual_proxy_configuration

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 290


def manual_proxy_configuration(**) = ManualProxyConfiguration.new(**)

#new(capabilities:)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 309


def new(capabilities:)
  params = NewParameters.new(capabilities: capabilities)
  execute(cmd: 'session.new', params: params, result: Session::NewResult)
end

#pac_proxy_configuration

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 291


def pac_proxy_configuration(**) = PacProxyConfiguration.new(**)

#proxy_configuration

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 287


def proxy_configuration = ProxyConfiguration

#status

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 317


def status
  execute(cmd: 'session.status', result: Session::StatusResult)
end

#system_proxy_configuration

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 292


def system_proxy_configuration(**) = SystemProxyConfiguration.new(**)

#unsubscribe(events: Serialization::UNSET, subscriptions: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 332


def unsubscribe(events: Serialization::UNSET, subscriptions: Serialization::UNSET)
  params = UnsubscribeParameters.build(events: events, subscriptions: subscriptions)
  execute(cmd: 'session.unsubscribe', params: params)
end

#unsubscribe_by_attributes_request

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 295


def unsubscribe_by_attributes_request(**) = UnsubscribeByAttributesRequest.new(**)

#unsubscribe_by_id_request

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 294


def unsubscribe_by_id_request(**) = UnsubscribeByIDRequest.new(**)

#user_prompt_handler

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 293


def user_prompt_handler(**) = UserPromptHandler.new(**)

Class: Selenium::WebDriver::BiDi::Protocol::Session Private

Overview

Constant Summary

Class Method Summary

Domain - Inherited

Instance Method Summary

Domain - Inherited

Constructor Details

Instance Method Details

#autodetect_proxy_configuration

#capabilities_request

#capability_request

#capability_request_firefox_options

#capability_request_firefox_options_log

#direct_proxy_configuration

#end_

#manual_proxy_configuration

#new(capabilities:)

#pac_proxy_configuration

#proxy_configuration

#status

#subscribe(events:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#system_proxy_configuration

#unsubscribe(events: Serialization::UNSET, subscriptions: Serialization::UNSET)

#unsubscribe_by_attributes_request

#unsubscribe_by_id_request

#user_prompt_handler

`Domain` - Inherited

`Domain` - Inherited