Class: Selenium::WebDriver::BiDi::Protocol::Emulation Private

Relationships & Source Files
Namespace Children
Classes: `SetGeolocationOverrideParameters`
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::Emulation
Defined in:	rb/lib/selenium/webdriver/bidi/protocol/emulation.rb

Overview

See Also:

Constant Summary

FORCED_COLORS_MODE_THEME =
See Also:
- https://w3c.github.io/webdriver-bidi/#cddl-type-emulationforcedcolorsmodetheme
# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 32
```
{
  light: 'light',
  dark: 'dark'
}.freeze
```

GeolocationCoordinates =

Serialization::Record.define(
  latitude: {wire_key: 'latitude', primitive: 'integer'},
  longitude: {wire_key: 'longitude', primitive: 'integer'},
  accuracy: {wire_key: 'accuracy', required: false, primitive: 'number'},
  altitude: {wire_key: 'altitude', required: false, nullable: true, primitive: 'number'},
  altitude_accuracy: {wire_key: 'altitudeAccuracy', required: false, nullable: true, primitive: 'number'},
  heading: {wire_key: 'heading', required: false, nullable: true, primitive: 'integer'},
  speed: {wire_key: 'speed', required: false, nullable: true, primitive: 'number'}
)

GeolocationPositionError =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-emulationgeolocationpositionerror
# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 103
```
Serialization::Record.define(type: {fixed: 'positionUnavailable'})
```
NetworkConditionsOffline =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-emulationnetworkconditionsoffline
# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 130
```
Serialization::Record.define(type: {fixed: 'offline'})
```
SCREEN_ORIENTATION_NATURAL =
See Also:
- https://w3c.github.io/webdriver-bidi/#cddl-type-emulationscreenorientationnatural
# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 38
```
{
  portrait: 'portrait',
  landscape: 'landscape'
}.freeze
```

SCREEN_ORIENTATION_TYPE =

See Also:

https://w3c.github.io/webdriver-bidi/#cddl-type-emulationscreenorientationtype

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 44

{
  portrait_primary: 'portrait-primary',
  portrait_secondary: 'portrait-secondary',
  landscape_primary: 'landscape-primary',
  landscape_secondary: 'landscape-secondary'
}.freeze

ScreenArea =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-emulationscreenarea
# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 135
```
Serialization::Record.define(
  width: {wire_key: 'width', primitive: 'integer'},
  height: {wire_key: 'height', primitive: 'integer'}
)
```
ScreenOrientation =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-emulationscreenorientation
# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 152
```
Serialization::Record.define(
  natural: {wire_key: 'natural', enum: 'Emulation::SCREEN_ORIENTATION_NATURAL'},
  type: {wire_key: 'type', enum: 'Emulation::SCREEN_ORIENTATION_TYPE'}
)
```
SetForcedColorsModeThemeOverrideParameters =
See Also:
- https://www.selenium.dev/documentation/warnings/bidi-implementation/
- https://w3c.github.io/webdriver-bidi/#cddl-type-emulationsetforcedcolorsmodethemeoverrideparameters
# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 54
```
Serialization::Record.define(
  theme: {wire_key: 'theme', nullable: true, enum: 'Emulation::FORCED_COLORS_MODE_THEME'},
  contexts: {wire_key: 'contexts', required: false, list: true},
  user_contexts: {wire_key: 'userContexts', required: false, list: true}
)
```

SetLocaleOverrideParameters =

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

SetNetworkConditionsParameters =

Serialization::Record.define(
  network_conditions: {
    wire_key: 'networkConditions',
    nullable: true,
    ref: 'Emulation::NetworkConditionsOffline'
  },
  contexts: {wire_key: 'contexts', required: false, list: true},
  user_contexts: {wire_key: 'userContexts', required: false, list: true}
)

SetScreenOrientationOverrideParameters =

Serialization::Record.define(
  screen_orientation: {wire_key: 'screenOrientation', nullable: true, ref: 'Emulation::ScreenOrientation'},
  contexts: {wire_key: 'contexts', required: false, list: true},
  user_contexts: {wire_key: 'userContexts', required: false, list: true}
)

SetScreenSettingsOverrideParameters =

Serialization::Record.define(
  screen_area: {wire_key: 'screenArea', nullable: true, ref: 'Emulation::ScreenArea'},
  contexts: {wire_key: 'contexts', required: false, list: true},
  user_contexts: {wire_key: 'userContexts', required: false, list: true}
)

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

SetScrollbarTypeOverrideParameters =

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

SetTimezoneOverrideParameters =

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

SetTouchOverrideParameters =

Serialization::Record.define(
  max_touch_points: {wire_key: 'maxTouchPoints', nullable: true, primitive: 'integer'},
  contexts: {wire_key: 'contexts', required: false, list: true},
  user_contexts: {wire_key: 'userContexts', required: false, list: true}
)

SetUserAgentOverrideParameters =

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

Class Method Summary

`Domain` - Inherited

.new

Instance Method Summary

#set_forced_colors_mode_theme_override(theme:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_geolocation_override(contexts: Serialization::UNSET, user_contexts: Serialization::UNSET, coordinates: Serialization::UNSET, error: Serialization::UNSET) Internal use only
#set_locale_override(locale:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_network_conditions(network_conditions:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_screen_orientation_override(screen_orientation:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_screen_settings_override(screen_area:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_scripting_enabled(enabled:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_scrollbar_type_override(scrollbar_type:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_timezone_override(timezone:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_touch_override(max_touch_points:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only
#set_user_agent_override(user_agent:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET) Internal use only

`Domain` - Inherited

#execute

Constructor Details

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

Instance Method Details

#set_forced_colors_mode_theme_override(theme:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 214


def set_forced_colors_mode_theme_override(
  theme:,
  contexts: Serialization::UNSET,
  user_contexts: Serialization::UNSET
)
  Serialization.validate!('theme', theme, Emulation::FORCED_COLORS_MODE_THEME)
  params = SetForcedColorsModeThemeOverrideParameters.new(
    theme: theme,
    contexts: contexts,
    user_contexts: user_contexts
  )
  execute(cmd: 'emulation.setForcedColorsModeThemeOverride', params: params)
end

#set_geolocation_override(contexts: Serialization::UNSET, user_contexts: Serialization::UNSET, coordinates: Serialization::UNSET, error: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 231


def set_geolocation_override(
  contexts: Serialization::UNSET,
  user_contexts: Serialization::UNSET,
  coordinates: Serialization::UNSET,
  error: Serialization::UNSET
)
  params = SetGeolocationOverrideParameters.build(
    contexts: contexts,
    user_contexts: user_contexts,
    coordinates: coordinates,
    error: error
  )
  execute(cmd: 'emulation.setGeolocationOverride', params: params)
end

#set_locale_override(locale:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 249


def set_locale_override(locale:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)
  params = SetLocaleOverrideParameters.new(locale: locale, contexts: contexts, user_contexts: user_contexts)
  execute(cmd: 'emulation.setLocaleOverride', params: params)
end

#set_network_conditions(network_conditions:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 257


def set_network_conditions(
  network_conditions:,
  contexts: Serialization::UNSET,
  user_contexts: Serialization::UNSET
)
  params = SetNetworkConditionsParameters.new(
    network_conditions: network_conditions,
    contexts: contexts,
    user_contexts: user_contexts
  )
  execute(cmd: 'emulation.setNetworkConditions', params: params)
end

#set_screen_orientation_override(screen_orientation:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 273


def set_screen_orientation_override(
  screen_orientation:,
  contexts: Serialization::UNSET,
  user_contexts: Serialization::UNSET
)
  params = SetScreenOrientationOverrideParameters.new(
    screen_orientation: screen_orientation,
    contexts: contexts,
    user_contexts: user_contexts
  )
  execute(cmd: 'emulation.setScreenOrientationOverride', params: params)
end

#set_screen_settings_override(screen_area:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

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


def set_screen_settings_override(
  screen_area:,
  contexts: Serialization::UNSET,
  user_contexts: Serialization::UNSET
)
  params = SetScreenSettingsOverrideParameters.new(
    screen_area: screen_area,
    contexts: contexts,
    user_contexts: user_contexts
  )
  execute(cmd: 'emulation.setScreenSettingsOverride', params: params)
end

#set_scripting_enabled(enabled:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 305


def set_scripting_enabled(enabled:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)
  params = SetScriptingEnabledParameters.new(
    enabled: enabled,
    contexts: contexts,
    user_contexts: user_contexts
  )
  execute(cmd: 'emulation.setScriptingEnabled', params: params)
end

#set_scrollbar_type_override(scrollbar_type:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

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


def set_scrollbar_type_override(
  scrollbar_type:,
  contexts: Serialization::UNSET,
  user_contexts: Serialization::UNSET
)
  params = SetScrollbarTypeOverrideParameters.new(
    scrollbar_type: scrollbar_type,
    contexts: contexts,
    user_contexts: user_contexts
  )
  execute(cmd: 'emulation.setScrollbarTypeOverride', params: params)
end

#set_timezone_override(timezone:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 333


def set_timezone_override(timezone:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)
  params = SetTimezoneOverrideParameters.new(
    timezone: timezone,
    contexts: contexts,
    user_contexts: user_contexts
  )
  execute(cmd: 'emulation.setTimezoneOverride', params: params)
end

#set_touch_override(max_touch_points:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 345


def set_touch_override(max_touch_points:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)
  params = SetTouchOverrideParameters.new(
    max_touch_points: max_touch_points,
    contexts: contexts,
    user_contexts: user_contexts
  )
  execute(cmd: 'emulation.setTouchOverride', params: params)
end

#set_user_agent_override(user_agent:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

See Also:

[ GitHub ]

# File 'rb/lib/selenium/webdriver/bidi/protocol/emulation.rb', line 357


def set_user_agent_override(user_agent:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)
  params = SetUserAgentOverrideParameters.new(
    user_agent: user_agent,
    contexts: contexts,
    user_contexts: user_contexts
  )
  execute(cmd: 'emulation.setUserAgentOverride', params: params)
end

Class: Selenium::WebDriver::BiDi::Protocol::Emulation Private

Overview

Constant Summary

Class Method Summary

Domain - Inherited

Instance Method Summary

Domain - Inherited

Constructor Details

Instance Method Details

#set_forced_colors_mode_theme_override(theme:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_geolocation_override(contexts: Serialization::UNSET, user_contexts: Serialization::UNSET, coordinates: Serialization::UNSET, error: Serialization::UNSET)

#set_locale_override(locale:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_network_conditions(network_conditions:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_screen_orientation_override(screen_orientation:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_screen_settings_override(screen_area:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_scripting_enabled(enabled:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_scrollbar_type_override(scrollbar_type:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_timezone_override(timezone:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_touch_override(max_touch_points:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

#set_user_agent_override(user_agent:, contexts: Serialization::UNSET, user_contexts: Serialization::UNSET)

`Domain` - Inherited

`Domain` - Inherited