Package org.openqa.selenium.devtools.input

Class Input

java.lang.Object

org.openqa.selenium.devtools.input.Input

public class Input
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Input.DispatchKeyEventType
static class	Input.DispatchMouseEventPointerType
static class	Input.DispatchMouseEventType
static class	Input.DispatchTouchEventType
static class	Input.EmulateTouchFromMouseEventType

Constructor Summary

Constructors

Constructor	Description
Input()

Method Summary

Modifier and Type	Method	Description
static Command<java.lang.Void>	dispatchKeyEvent(Input.DispatchKeyEventType type, java.util.Optional<java.lang.Integer> modifiers, java.util.Optional<TimeSinceEpoch> timestamp, java.util.Optional<java.lang.String> text, java.util.Optional<java.lang.String> unmodifiedText, java.util.Optional<java.lang.String> keyIdentifier, java.util.Optional<java.lang.String> code, java.util.Optional<java.lang.String> key, java.util.Optional<java.lang.Integer> windowsVirtualKeyCode, java.util.Optional<java.lang.Integer> nativeVirtualKeyCode, java.util.Optional<java.lang.Boolean> autoRepeat, java.util.Optional<java.lang.Boolean> isKeypad, java.util.Optional<java.lang.Boolean> isSystemKey, java.util.Optional<java.lang.Integer> location)	Dispatches a key event to the page.
static Command<java.lang.Void>	dispatchMouseEvent(Input.DispatchMouseEventType type, java.lang.Number x, java.lang.Number y, java.util.Optional<java.lang.Integer> modifiers, java.util.Optional<TimeSinceEpoch> timestamp, java.util.Optional<MouseButton> button, java.util.Optional<java.lang.Integer> buttons, java.util.Optional<java.lang.Integer> clickCount, java.util.Optional<java.lang.Number> deltaX, java.util.Optional<java.lang.Number> deltaY, java.util.Optional<Input.DispatchMouseEventPointerType> pointerType)	Dispatches a mouse event to the page.
static Command<java.lang.Void>	dispatchTouchEvent(Input.DispatchTouchEventType type, java.util.List<TouchPoint> touchPoints, java.util.Optional<java.lang.Integer> modifiers, java.util.Optional<TimeSinceEpoch> timestamp)	Dispatches a touch event to the page.
static Command<java.lang.Void>	emulateTouchFromMouseEvent(Input.EmulateTouchFromMouseEventType type, java.lang.Integer x, java.lang.Integer y, MouseButton button, java.util.Optional<TimeSinceEpoch> timestamp, java.util.Optional<java.lang.Number> deltaX, java.util.Optional<java.lang.Number> deltaY, java.util.Optional<java.lang.Integer> modifiers, java.util.Optional<java.lang.Integer> clickCount)	Emulates touch event from the mouse event parameters.
static Command<java.lang.Void>	insertText(java.lang.String text)	This method emulates inserting text that doesn't come from a key press, for example an emoji keyboard or an IME.
static Command<java.lang.Void>	setIgnoreInputEvents(java.lang.Boolean ignore)	Ignores input events (useful while auditing page).
static Command<java.lang.Void>	synthesizePinchGesture(java.lang.Number x, java.lang.Number y, java.lang.Number scaleFactor, java.util.Optional<java.lang.Integer> relativeSpeed, java.util.Optional<GestureSourceType> gestureSourceType)	Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
static Command<java.lang.Void>	synthesizeScrollGesture(java.lang.Number x, java.lang.Number y, java.util.Optional<java.lang.Number> xDistance, java.util.Optional<java.lang.Number> yDistance, java.util.Optional<java.lang.Number> xOverscroll, java.util.Optional<java.lang.Number> yOverscroll, java.util.Optional<java.lang.Boolean> preventFling, java.util.Optional<java.lang.Integer> speed, java.util.Optional<GestureSourceType> gestureSourceType, java.util.Optional<java.lang.Integer> repeatCount, java.util.Optional<java.lang.Integer> repeatDelayMs, java.util.Optional<java.lang.String> interactionMarkerName)	Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
static Command<java.lang.Void>	synthesizeTapGesture(java.lang.Number x, java.lang.Number y, java.util.Optional<java.lang.Integer> duration, java.util.Optional<java.lang.Integer> tapCount, java.util.Optional<GestureSourceType> gestureSourceType)	Synthesizes a tap gesture over a time period by issuing appropriate touch events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Input

public Input()

Method Detail

dispatchKeyEvent

public static Command<java.lang.Void> dispatchKeyEvent(Input.DispatchKeyEventType type,
                                                       java.util.Optional<java.lang.Integer> modifiers,
                                                       java.util.Optional<TimeSinceEpoch> timestamp,
                                                       java.util.Optional<java.lang.String> text,
                                                       java.util.Optional<java.lang.String> unmodifiedText,
                                                       java.util.Optional<java.lang.String> keyIdentifier,
                                                       java.util.Optional<java.lang.String> code,
                                                       java.util.Optional<java.lang.String> key,
                                                       java.util.Optional<java.lang.Integer> windowsVirtualKeyCode,
                                                       java.util.Optional<java.lang.Integer> nativeVirtualKeyCode,
                                                       java.util.Optional<java.lang.Boolean> autoRepeat,
                                                       java.util.Optional<java.lang.Boolean> isKeypad,
                                                       java.util.Optional<java.lang.Boolean> isSystemKey,
                                                       java.util.Optional<java.lang.Integer> location)

Dispatches a key event to the page.

insertText

@Beta
public static Command<java.lang.Void> insertText(java.lang.String text)

This method emulates inserting text that doesn't come from a key press, for example an emoji keyboard or an IME.

dispatchMouseEvent

public static Command<java.lang.Void> dispatchMouseEvent(Input.DispatchMouseEventType type,
                                                         java.lang.Number x,
                                                         java.lang.Number y,
                                                         java.util.Optional<java.lang.Integer> modifiers,
                                                         java.util.Optional<TimeSinceEpoch> timestamp,
                                                         java.util.Optional<MouseButton> button,
                                                         java.util.Optional<java.lang.Integer> buttons,
                                                         java.util.Optional<java.lang.Integer> clickCount,
                                                         java.util.Optional<java.lang.Number> deltaX,
                                                         java.util.Optional<java.lang.Number> deltaY,
                                                         java.util.Optional<Input.DispatchMouseEventPointerType> pointerType)

Dispatches a mouse event to the page.

dispatchTouchEvent

public static Command<java.lang.Void> dispatchTouchEvent(Input.DispatchTouchEventType type,
                                                         java.util.List<TouchPoint> touchPoints,
                                                         java.util.Optional<java.lang.Integer> modifiers,
                                                         java.util.Optional<TimeSinceEpoch> timestamp)

Dispatches a touch event to the page.

emulateTouchFromMouseEvent

@Beta
public static Command<java.lang.Void> emulateTouchFromMouseEvent(Input.EmulateTouchFromMouseEventType type,
                                                                 java.lang.Integer x,
                                                                 java.lang.Integer y,
                                                                 MouseButton button,
                                                                 java.util.Optional<TimeSinceEpoch> timestamp,
                                                                 java.util.Optional<java.lang.Number> deltaX,
                                                                 java.util.Optional<java.lang.Number> deltaY,
                                                                 java.util.Optional<java.lang.Integer> modifiers,
                                                                 java.util.Optional<java.lang.Integer> clickCount)

Emulates touch event from the mouse event parameters.

setIgnoreInputEvents

public static Command<java.lang.Void> setIgnoreInputEvents(java.lang.Boolean ignore)

Ignores input events (useful while auditing page).

synthesizePinchGesture

@Beta
public static Command<java.lang.Void> synthesizePinchGesture(java.lang.Number x,
                                                             java.lang.Number y,
                                                             java.lang.Number scaleFactor,
                                                             java.util.Optional<java.lang.Integer> relativeSpeed,
                                                             java.util.Optional<GestureSourceType> gestureSourceType)

Synthesizes a pinch gesture over a time period by issuing appropriate touch events.

synthesizeScrollGesture

@Beta
public static Command<java.lang.Void> synthesizeScrollGesture(java.lang.Number x,
                                                              java.lang.Number y,
                                                              java.util.Optional<java.lang.Number> xDistance,
                                                              java.util.Optional<java.lang.Number> yDistance,
                                                              java.util.Optional<java.lang.Number> xOverscroll,
                                                              java.util.Optional<java.lang.Number> yOverscroll,
                                                              java.util.Optional<java.lang.Boolean> preventFling,
                                                              java.util.Optional<java.lang.Integer> speed,
                                                              java.util.Optional<GestureSourceType> gestureSourceType,
                                                              java.util.Optional<java.lang.Integer> repeatCount,
                                                              java.util.Optional<java.lang.Integer> repeatDelayMs,
                                                              java.util.Optional<java.lang.String> interactionMarkerName)

Synthesizes a scroll gesture over a time period by issuing appropriate touch events.

synthesizeTapGesture

@Beta
public static Command<java.lang.Void> synthesizeTapGesture(java.lang.Number x,
                                                           java.lang.Number y,
                                                           java.util.Optional<java.lang.Integer> duration,
                                                           java.util.Optional<java.lang.Integer> tapCount,
                                                           java.util.Optional<GestureSourceType> gestureSourceType)

Synthesizes a tap gesture over a time period by issuing appropriate touch events.