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

Inherits:
Domain
  • Object
show all
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:

Defined Under Namespace

Classes: KeySourceAction, Origin, PointerSourceAction, SourceActions, WheelSourceAction

Constant Summary collapse

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. 

{
  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:

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:

Serialization::Record.define(
  context: 'context',
  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:

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:

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:

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:

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:

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:

Serialization::Record.define(
  type: {fixed: 'pause'},
  duration: {wire_key: 'duration', required: false}
)
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:

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:

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:

Serialization::Record.define(type: {fixed: 'pointerUp'}, button: 'button')
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:

Serialization::Record.define(
  type: {fixed: 'pointerDown'},
  button: 'button',
  width: {wire_key: 'width', required: false},
  height: {wire_key: 'height', required: false},
  pressure: {wire_key: 'pressure', required: false, primitive: 'integer'},
  tangential_pressure: {wire_key: 'tangentialPressure', required: false, primitive: 'integer'},
  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:

Serialization::Record.define(
  type: {fixed: 'pointerMove'},
  x: {wire_key: 'x', primitive: 'number'},
  y: {wire_key: 'y', primitive: 'number'},
  duration: {wire_key: 'duration', required: false},
  origin: {wire_key: 'origin', required: false, ref: 'Input::Origin'},
  width: {wire_key: 'width', required: false},
  height: {wire_key: 'height', required: false},
  pressure: {wire_key: 'pressure', required: false, primitive: 'integer'},
  tangential_pressure: {wire_key: 'tangentialPressure', required: false, primitive: 'integer'},
  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:

Serialization::Record.define(
  type: {fixed: 'scroll'},
  x: 'x',
  y: 'y',
  delta_x: 'deltaX',
  delta_y: 'deltaY',
  duration: {wire_key: 'duration', required: false},
  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:

Serialization::Record.define(
  width: {wire_key: 'width', required: false},
  height: {wire_key: 'height', required: false},
  pressure: {wire_key: 'pressure', required: false, primitive: 'integer'},
  tangential_pressure: {wire_key: 'tangentialPressure', required: false, primitive: 'integer'},
  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:

Serialization::Record.define(context: 'context')
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:

Serialization::Record.define(
  context: 'context',
  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:

Serialization::Record.define(
  context: 'context',
  user_context: {wire_key: 'userContext', required: false},
  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 collapse

Methods inherited from Domain

#initialize

Constructor Details

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

Instance Method Details

#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:



259
260
261
262
 
# File 'lib/selenium/webdriver/bidi/protocol/input.rb', line 259

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

#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:



266
267
268
269
 
# File 'lib/selenium/webdriver/bidi/protocol/input.rb', line 266

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:



273
274
275
276
 
# File 'lib/selenium/webdriver/bidi/protocol/input.rb', line 273

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