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

Inherits:

Domain

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

Defined in:

lib/selenium/webdriver/bidi/protocol/session.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/

Defined Under Namespace

Classes: ProxyConfiguration, UnsubscribeParameters

Constant Summary

USER_PROMPT_HANDLER_TYPE =

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.

{
  accept: 'accept',
  dismiss: 'dismiss',
  ignore: 'ignore'
}.freeze

CapabilitiesRequest =

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/

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 =

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/

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
)

AutodetectProxyConfiguration =

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/

Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'autodetect'},
  extensible: true
)

DirectProxyConfiguration =

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/

Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'direct'},
  extensible: true
)

ManualProxyConfiguration =

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/

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
)

SocksProxyConfiguration =

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/

Serialization::Record.define(
  socks_proxy: {wire_key: 'socksProxy', primitive: 'string'},
  socks_version: {wire_key: 'socksVersion', primitive: 'integer'}
)

PacProxyConfiguration =

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/

Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'pac'},
  proxy_autoconfig_url: {wire_key: 'proxyAutoconfigUrl', primitive: 'string'},
  extensible: true
)

SystemProxyConfiguration =

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/

Serialization::Record.define(
  proxy_type: {wire_key: 'proxyType', fixed: 'system'},
  extensible: true
)

UserPromptHandler =

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/

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'}
)

SubscribeParameters =

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/

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}
)

UnsubscribeByIDRequest =

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/

Serialization::Record.define(subscriptions: {wire_key: 'subscriptions', list: true})

UnsubscribeByAttributesRequest =

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/

Serialization::Record.define(events: {wire_key: 'events', list: true})

StatusResult =

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/

Serialization::Record.define(
  ready: {wire_key: 'ready', primitive: 'boolean'},
  message: {wire_key: 'message', primitive: 'string'}
)

NewParameters =

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/

Serialization::Record.define(
  capabilities: {wire_key: 'capabilities', ref: 'Session::CapabilitiesRequest'}
)

NewResult =

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/

Serialization::Record.define(
  session_id: {wire_key: 'sessionId', primitive: 'string'},
  capabilities: {wire_key: 'capabilities', ref: 'Session::NewResult::Capabilities'}
)

SubscribeResult =

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/

Serialization::Record.define(subscription: 'subscription')

Instance Method Summary

• #end_ ⇒ Object private
• #new(capabilities:) ⇒ Object private
• #status ⇒ Object private
• #subscribe(events:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) ⇒ Object private
• #unsubscribe(events: Serialization::UNSET, subscriptions: 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

#end_ ⇒ 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/

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

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

#new(capabilities:) ⇒ 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/

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

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

#status ⇒ 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/

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

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

#subscribe(events:, contexts: Serialization::UNSET, 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/

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

def subscribe(events:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)
  params = SubscribeParameters.new(events: events, contexts: contexts, user_contexts: user_contexts)
  execute(cmd: 'session.subscribe', params: params, result: Session::SubscribeResult)
end

#unsubscribe(events: Serialization::UNSET, subscriptions: 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/

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

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