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 87
```
Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'autodetect'},
  extensible: true
)
```

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'
  },
  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 95
```
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'},
  no_proxy: {wire_key: 'noProxy', required: false, list: true},
  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 180
```
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 187
```
Serialization::Record.define(
  session_id: {wire_key: 'sessionId', primitive: 'string'},
  capabilities: {wire_key: 'capabilities', ref: 'Session::NewResult::Capabilities'}
)
```
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 124
```
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 116
```
Serialization::Record.define(
  socks_proxy: {wire_key: 'socksProxy', primitive: 'string'},
  socks_version: {wire_key: 'socksVersion', primitive: 'integer'}
)
```
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 172
```
Serialization::Record.define(
  ready: {wire_key: 'ready', primitive: 'boolean'},
  message: {wire_key: 'message', primitive: 'string'}
)
```
SubscribeParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-sessionsubscribeparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/session.rb', line 153
```
Serialization::Record.define(
  events: {wire_key: 'events', list: true},
  contexts: {wire_key: 'contexts', required: false, list: true},
  user_contexts: {wire_key: 'userContexts', required: false, list: true}
)
```
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 213
```
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 133
```
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 167
```
Serialization::Record.define(events: {wire_key: 'events', list: true})
```
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 162
```
Serialization::Record.define(subscriptions: {wire_key: 'subscriptions', list: true})
```

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

#end_ Internal use only
#new(capabilities:) Internal use only
#status Internal use only
#subscribe(events:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#unsubscribe(events: Serialization::UNSET, subscriptions: Serialization::UNSET) Internal use only

`Domain` - Inherited

#execute

Constructor Details

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

Instance Method Details

#end_

See Also:

[ GitHub ]

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


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

#new(capabilities:)

See Also:

[ GitHub ]

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


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

#status

See Also:

[ GitHub ]

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


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

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

See Also:

[ GitHub ]

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


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

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

#end_

#new(capabilities:)

#status

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

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

`Domain` - Inherited

`Domain` - Inherited