Class: Selenium::WebDriver::BiDi::Protocol::Input Private

Inherits:

Domain

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

Defined in:

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

Defined Under Namespace

Classes: KeySourceAction, Origin, PointerSourceAction, SourceActions, WheelSourceAction

Constant Summary

EVENTS =

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.

{
  file_dialog_opened: 'input.fileDialogOpened'
}.freeze

POINTER_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.

See Also:

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

{
  mouse: 'mouse',
  pen: 'pen',
  touch: 'touch'
}.freeze

ElementOrigin =

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-inputelementorigin

Serialization::Record.define(
  type: {fixed: 'element'},
  element: {wire_key: 'element', ref: 'Script::SharedReference'}
)

PerformActionsParameters =

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-inputperformactionsparameters

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  actions: {wire_key: 'actions', ref: 'Input::SourceActions', list: true}
)

NoneSourceActions =

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-inputnonesourceactions

Serialization::Record.define(
  type: {fixed: 'none'},
  id: {wire_key: 'id', primitive: 'string'},
  actions: {wire_key: 'actions', ref: 'Input::PauseAction', list: true}
)

KeySourceActions =

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-inputkeysourceactions

Serialization::Record.define(
  type: {fixed: 'key'},
  id: {wire_key: 'id', primitive: 'string'},
  actions: {wire_key: 'actions', ref: 'Input::KeySourceAction', list: true}
)

PointerSourceActions =

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-inputpointersourceactions

Serialization::Record.define(
  type: {fixed: 'pointer'},
  id: {wire_key: 'id', primitive: 'string'},
  parameters: {wire_key: 'parameters', required: false, ref: 'Input::PointerParameters'},
  actions: {wire_key: 'actions', ref: 'Input::PointerSourceAction', list: true}
)

PointerParameters =

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-inputpointerparameters

Serialization::Record.define(
  pointer_type: {wire_key: 'pointerType', required: false, enum: 'Input::POINTER_TYPE'}
)

WheelSourceActions =

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-inputwheelsourceactions

Serialization::Record.define(
  type: {fixed: 'wheel'},
  id: {wire_key: 'id', primitive: 'string'},
  actions: {wire_key: 'actions', ref: 'Input::WheelSourceAction', list: true}
)

PauseAction =

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-inputpauseaction

Serialization::Record.define(
  type: {fixed: 'pause'},
  duration: {wire_key: 'duration', required: false, primitive: 'integer'}
)

KeyDownAction =

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-inputkeydownaction

Serialization::Record.define(
  type: {fixed: 'keyDown'},
  value: {wire_key: 'value', primitive: 'string'}
)

KeyUpAction =

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-inputkeyupaction

Serialization::Record.define(
  type: {fixed: 'keyUp'},
  value: {wire_key: 'value', primitive: 'string'}
)

PointerUpAction =

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-inputpointerupaction

Serialization::Record.define(
  type: {fixed: 'pointerUp'},
  button: {wire_key: 'button', primitive: 'integer'}
)

PointerDownAction =

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-inputpointerdownaction

Serialization::Record.define(
  type: {fixed: 'pointerDown'},
  button: {wire_key: 'button', primitive: 'integer'},
  width: {wire_key: 'width', required: false, primitive: 'integer'},
  height: {wire_key: 'height', required: false, primitive: 'integer'},
  pressure: {wire_key: 'pressure', required: false, primitive: 'number'},
  tangential_pressure: {wire_key: 'tangentialPressure', required: false, primitive: 'number'},
  twist: {wire_key: 'twist', required: false, primitive: 'integer'},
  altitude_angle: {wire_key: 'altitudeAngle', required: false, primitive: 'number'},
  azimuth_angle: {wire_key: 'azimuthAngle', required: false, primitive: 'number'}
)

PointerMoveAction =

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-inputpointermoveaction

Serialization::Record.define(
  type: {fixed: 'pointerMove'},
  x: {wire_key: 'x', primitive: 'number'},
  y: {wire_key: 'y', primitive: 'number'},
  duration: {wire_key: 'duration', required: false, primitive: 'integer'},
  origin: {wire_key: 'origin', required: false, ref: 'Input::Origin'},
  width: {wire_key: 'width', required: false, primitive: 'integer'},
  height: {wire_key: 'height', required: false, primitive: 'integer'},
  pressure: {wire_key: 'pressure', required: false, primitive: 'number'},
  tangential_pressure: {wire_key: 'tangentialPressure', required: false, primitive: 'number'},
  twist: {wire_key: 'twist', required: false, primitive: 'integer'},
  altitude_angle: {wire_key: 'altitudeAngle', required: false, primitive: 'number'},
  azimuth_angle: {wire_key: 'azimuthAngle', required: false, primitive: 'number'}
)

WheelScrollAction =

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-inputwheelscrollaction

Serialization::Record.define(
  type: {fixed: 'scroll'},
  x: {wire_key: 'x', primitive: 'integer'},
  y: {wire_key: 'y', primitive: 'integer'},
  delta_x: {wire_key: 'deltaX', primitive: 'integer'},
  delta_y: {wire_key: 'deltaY', primitive: 'integer'},
  duration: {wire_key: 'duration', required: false, primitive: 'integer'},
  origin: {wire_key: 'origin', required: false, ref: 'Input::Origin'}
)

PointerCommonProperties =

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-inputpointercommonproperties

Serialization::Record.define(
  width: {wire_key: 'width', required: false, primitive: 'integer'},
  height: {wire_key: 'height', required: false, primitive: 'integer'},
  pressure: {wire_key: 'pressure', required: false, primitive: 'number'},
  tangential_pressure: {wire_key: 'tangentialPressure', required: false, primitive: 'number'},
  twist: {wire_key: 'twist', required: false, primitive: 'integer'},
  altitude_angle: {wire_key: 'altitudeAngle', required: false, primitive: 'number'},
  azimuth_angle: {wire_key: 'azimuthAngle', required: false, primitive: 'number'}
)

ReleaseActionsParameters =

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-inputreleaseactionsparameters

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

SetFilesParameters =

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-inputsetfilesparameters

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  element: {wire_key: 'element', ref: 'Script::SharedReference'},
  files: {wire_key: 'files', list: true}
)

FileDialogInfo =

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-inputfiledialoginfo

Serialization::Record.define(
  context: {wire_key: 'context', primitive: 'string'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'},
  element: {wire_key: 'element', required: false, ref: 'Script::SharedReference'},
  multiple: {wire_key: 'multiple', primitive: 'boolean'}
)

EVENT_TYPES =

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.

{
  'input.fileDialogOpened' => Input::FileDialogInfo
}.freeze

Instance Method Summary

• #element_origin ⇒ Object private
• #key_down_action ⇒ Object private
• #key_source_action ⇒ Object private
• #key_source_actions ⇒ Object private
• #key_up_action ⇒ Object private
• #none_source_actions ⇒ Object private
• #pause_action ⇒ Object private
• #perform_actions(context:, actions:) ⇒ Object private
• #pointer_down_action ⇒ Object private
• #pointer_move_action ⇒ Object private
• #pointer_parameters ⇒ Object private
• #pointer_source_action ⇒ Object private
• #pointer_source_actions ⇒ Object private
• #pointer_up_action ⇒ Object private
• #release_actions(context:) ⇒ Object private
• #set_files(context:, element:, files:) ⇒ Object private
• #source_actions ⇒ Object private
• #wheel_scroll_action ⇒ Object private
• #wheel_source_action ⇒ Object private
• #wheel_source_actions ⇒ Object private

Methods inherited from Domain

#initialize

Constructor Details

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

Instance Method Details

#element_origin ⇒ 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/input.rb', line 309

def element_origin(**) = ElementOrigin.new(**)

#key_down_action ⇒ 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/input.rb', line 320

def key_down_action(**) = KeyDownAction.new(**)

#key_source_action ⇒ 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/input.rb', line 313

def key_source_action = KeySourceAction

#key_source_actions ⇒ 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/input.rb', line 312

def key_source_actions(**) = KeySourceActions.new(**)

#key_up_action ⇒ 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/input.rb', line 321

def key_up_action(**) = KeyUpAction.new(**)

#none_source_actions ⇒ 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/input.rb', line 311

def none_source_actions(**) = NoneSourceActions.new(**)

#pause_action ⇒ 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/input.rb', line 319

def pause_action(**) = PauseAction.new(**)

#perform_actions(context:, actions:) ⇒ 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-input-performActions

# File 'lib/selenium/webdriver/bidi/protocol/input.rb', line 330

def perform_actions(context:, actions:)
  params = PerformActionsParameters.new(context: context, actions: actions)
  execute(cmd: 'input.performActions', params: params)
end

#pointer_down_action ⇒ 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/input.rb', line 323

def pointer_down_action(**) = PointerDownAction.new(**)

#pointer_move_action ⇒ 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/input.rb', line 324

def pointer_move_action(**) = PointerMoveAction.new(**)

#pointer_parameters ⇒ 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/input.rb', line 315

def pointer_parameters(**) = PointerParameters.new(**)

#pointer_source_action ⇒ 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/input.rb', line 316

def pointer_source_action = PointerSourceAction

#pointer_source_actions ⇒ 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/input.rb', line 314

def pointer_source_actions(**) = PointerSourceActions.new(**)

#pointer_up_action ⇒ 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/input.rb', line 322

def pointer_up_action(**) = PointerUpAction.new(**)

#release_actions(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-input-releaseActions

# File 'lib/selenium/webdriver/bidi/protocol/input.rb', line 338

def release_actions(context:)
  params = ReleaseActionsParameters.new(context: context)
  execute(cmd: 'input.releaseActions', params: params)
end

#set_files(context:, element:, files:) ⇒ 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-input-setFiles

# File 'lib/selenium/webdriver/bidi/protocol/input.rb', line 346

def set_files(context:, element:, files:)
  params = SetFilesParameters.new(context: context, element: element, files: files)
  execute(cmd: 'input.setFiles', params: params)
end

#source_actions ⇒ 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/input.rb', line 310

def source_actions = SourceActions

#wheel_scroll_action ⇒ 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/input.rb', line 325

def wheel_scroll_action(**) = WheelScrollAction.new(**)

#wheel_source_action ⇒ 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/input.rb', line 318

def wheel_source_action = WheelSourceAction

#wheel_source_actions ⇒ 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/input.rb', line 317

def wheel_source_actions(**) = WheelSourceActions.new(**)