Skip to content

Input Protocol

Input domain commands, events and types for Chrome DevTools Protocol.

Methods

pydoll.protocol.input.methods

CancelDraggingCommand module-attribute

CancelDraggingCommand = Command[EmptyParams, EmptyResponse]

DispatchDragEventCommand module-attribute

DispatchDragEventCommand = Command[DispatchDragEventParams, EmptyResponse]

DispatchKeyEventCommand module-attribute

DispatchKeyEventCommand = Command[DispatchKeyEventParams, EmptyResponse]

DispatchMouseEventCommand module-attribute

DispatchMouseEventCommand = Command[DispatchMouseEventParams, EmptyResponse]

DispatchTouchEventCommand module-attribute

DispatchTouchEventCommand = Command[DispatchTouchEventParams, EmptyResponse]

EmulateTouchFromMouseEventCommand module-attribute

EmulateTouchFromMouseEventCommand = Command[EmulateTouchFromMouseEventParams, EmptyResponse]

ImeSetCompositionCommand module-attribute

ImeSetCompositionCommand = Command[ImeSetCompositionParams, EmptyResponse]

InsertTextCommand module-attribute

InsertTextCommand = Command[InsertTextParams, EmptyResponse]

SetIgnoreInputEventsCommand module-attribute

SetIgnoreInputEventsCommand = Command[SetIgnoreInputEventsParams, EmptyResponse]

SetInterceptDragsCommand module-attribute

SetInterceptDragsCommand = Command[SetInterceptDragsParams, EmptyResponse]

SynthesizePinchGestureCommand module-attribute

SynthesizePinchGestureCommand = Command[SynthesizePinchGestureParams, EmptyResponse]

SynthesizeScrollGestureCommand module-attribute

SynthesizeScrollGestureCommand = Command[SynthesizeScrollGestureParams, EmptyResponse]

SynthesizeTapGestureCommand module-attribute

SynthesizeTapGestureCommand = Command[SynthesizeTapGestureParams, EmptyResponse]

InputMethod

Bases: str, Enum

CANCEL_DRAGGING class-attribute instance-attribute

CANCEL_DRAGGING = 'Input.cancelDragging'

DISPATCH_KEY_EVENT class-attribute instance-attribute

DISPATCH_KEY_EVENT = 'Input.dispatchKeyEvent'

DISPATCH_MOUSE_EVENT class-attribute instance-attribute

DISPATCH_MOUSE_EVENT = 'Input.dispatchMouseEvent'

DISPATCH_TOUCH_EVENT class-attribute instance-attribute

DISPATCH_TOUCH_EVENT = 'Input.dispatchTouchEvent'

SET_IGNORE_INPUT_EVENTS class-attribute instance-attribute

SET_IGNORE_INPUT_EVENTS = 'Input.setIgnoreInputEvents'

DISPATCH_DRAG_EVENT class-attribute instance-attribute

DISPATCH_DRAG_EVENT = 'Input.dispatchDragEvent'

EMULATE_TOUCH_FROM_MOUSE_EVENT class-attribute instance-attribute

EMULATE_TOUCH_FROM_MOUSE_EVENT = 'Input.emulateTouchFromMouseEvent'

IME_SET_COMPOSITION class-attribute instance-attribute

IME_SET_COMPOSITION = 'Input.imeSetComposition'

INSERT_TEXT class-attribute instance-attribute

INSERT_TEXT = 'Input.insertText'

SET_INTERCEPT_DRAGS class-attribute instance-attribute

SET_INTERCEPT_DRAGS = 'Input.setInterceptDrags'

SYNTHESIZE_PINCH_GESTURE class-attribute instance-attribute

SYNTHESIZE_PINCH_GESTURE = 'Input.synthesizePinchGesture'

SYNTHESIZE_SCROLL_GESTURE class-attribute instance-attribute

SYNTHESIZE_SCROLL_GESTURE = 'Input.synthesizeScrollGesture'

SYNTHESIZE_TAP_GESTURE class-attribute instance-attribute

SYNTHESIZE_TAP_GESTURE = 'Input.synthesizeTapGesture'

CancelDraggingParams

Bases: TypedDict

Parameters for cancelDragging command.

DispatchDragEventParams

Bases: TypedDict

Parameters for dispatchDragEvent command.

type instance-attribute

type

x instance-attribute

x

y instance-attribute

y

data instance-attribute

data

modifiers instance-attribute

modifiers

DispatchKeyEventParams

Bases: TypedDict

Parameters for dispatchKeyEvent command.

type instance-attribute

type

modifiers instance-attribute

modifiers

timestamp instance-attribute

timestamp

text instance-attribute

text

unmodifiedText instance-attribute

unmodifiedText

keyIdentifier instance-attribute

keyIdentifier

code instance-attribute

code

key instance-attribute

key

windowsVirtualKeyCode instance-attribute

windowsVirtualKeyCode

nativeVirtualKeyCode instance-attribute

nativeVirtualKeyCode

autoRepeat instance-attribute

autoRepeat

isKeypad instance-attribute

isKeypad

isSystemKey instance-attribute

isSystemKey

location instance-attribute

location

commands instance-attribute

commands

DispatchMouseEventParams

Bases: TypedDict

Parameters for dispatchMouseEvent command.

type instance-attribute

type

x instance-attribute

x

y instance-attribute

y

modifiers instance-attribute

modifiers

timestamp instance-attribute

timestamp

button instance-attribute

button

buttons instance-attribute

buttons

clickCount instance-attribute

clickCount

force instance-attribute

force

tangentialPressure instance-attribute

tangentialPressure

tiltX instance-attribute

tiltX

tiltY instance-attribute

tiltY

twist instance-attribute

twist

deltaX instance-attribute

deltaX

deltaY instance-attribute

deltaY

pointerType instance-attribute

pointerType

DispatchTouchEventParams

Bases: TypedDict

Parameters for dispatchTouchEvent command.

type instance-attribute

type

touchPoints instance-attribute

touchPoints

modifiers instance-attribute

modifiers

timestamp instance-attribute

timestamp

EmulateTouchFromMouseEventParams

Bases: TypedDict

Parameters for emulateTouchFromMouseEvent command.

type instance-attribute

type

x instance-attribute

x

y instance-attribute

y

button instance-attribute

button

timestamp instance-attribute

timestamp

deltaX instance-attribute

deltaX

deltaY instance-attribute

deltaY

modifiers instance-attribute

modifiers

clickCount instance-attribute

clickCount

ImeSetCompositionParams

Bases: TypedDict

Parameters for imeSetComposition command.

text instance-attribute

text

selectionStart instance-attribute

selectionStart

selectionEnd instance-attribute

selectionEnd

replacementStart instance-attribute

replacementStart

replacementEnd instance-attribute

replacementEnd

InsertTextParams

Bases: TypedDict

Parameters for insertText command.

text instance-attribute

text

SetIgnoreInputEventsParams

Bases: TypedDict

Parameters for setIgnoreInputEvents command.

ignore instance-attribute

ignore

SetInterceptDragsParams

Bases: TypedDict

Parameters for setInterceptDrags command.

enabled instance-attribute

enabled

SynthesizePinchGestureParams

Bases: TypedDict

Parameters for synthesizePinchGesture command.

x instance-attribute

x

y instance-attribute

y

scaleFactor instance-attribute

scaleFactor

relativeSpeed instance-attribute

relativeSpeed

gestureSourceType instance-attribute

gestureSourceType

SynthesizeScrollGestureParams

Bases: TypedDict

Parameters for synthesizeScrollGesture command.

x instance-attribute

x

y instance-attribute

y

xDistance instance-attribute

xDistance

yDistance instance-attribute

yDistance

xOverscroll instance-attribute

xOverscroll

yOverscroll instance-attribute

yOverscroll

preventFling instance-attribute

preventFling

speed instance-attribute

speed

gestureSourceType instance-attribute

gestureSourceType

repeatCount instance-attribute

repeatCount

repeatDelayMs instance-attribute

repeatDelayMs

interactionMarkerName instance-attribute

interactionMarkerName

SynthesizeTapGestureParams

Bases: TypedDict

Parameters for synthesizeTapGesture command.

x instance-attribute

x

y instance-attribute

y

duration instance-attribute

duration

tapCount instance-attribute

tapCount

gestureSourceType instance-attribute

gestureSourceType

Events

pydoll.protocol.input.events

DragInterceptedEvent module-attribute

DragInterceptedEvent = CDPEvent[DragInterceptedEventParams]

InputEvent

Bases: str, Enum

Events from the Input domain of the Chrome DevTools Protocol.

This enumeration contains the names of Input-related events that can be received from the Chrome DevTools Protocol. These events provide information about user input interactions that can be intercepted or simulated.

DRAG_INTERCEPTED class-attribute instance-attribute

DRAG_INTERCEPTED = 'Input.dragIntercepted'

Emitted only when Input.setInterceptDrags is enabled. Use this data with Input.dispatchDragEvent to restore normal drag and drop behavior.

PARAMETER DESCRIPTION
data

Contains information about the dragged data.

TYPE: DragData

DragInterceptedEventParams

Bases: TypedDict

Parameters for dragIntercepted event.

data instance-attribute

data

Types

pydoll.protocol.input.types

TimeSinceEpoch module-attribute

TimeSinceEpoch = float

GestureSourceType

Bases: str, Enum

Gesture source types.

DEFAULT class-attribute instance-attribute

DEFAULT = 'default'

TOUCH class-attribute instance-attribute

TOUCH = 'touch'

MOUSE class-attribute instance-attribute

MOUSE = 'mouse'

MouseButton

Bases: str, Enum

Mouse button types.

NONE class-attribute instance-attribute

NONE = 'none'

LEFT class-attribute instance-attribute

LEFT = 'left'

MIDDLE class-attribute instance-attribute

MIDDLE = 'middle'

RIGHT class-attribute instance-attribute

RIGHT = 'right'

BACK class-attribute instance-attribute

BACK = 'back'

FORWARD class-attribute instance-attribute

FORWARD = 'forward'

DragEventType

Bases: str, Enum

Drag event types.

DRAG_ENTER class-attribute instance-attribute

DRAG_ENTER = 'dragEnter'

DRAG_OVER class-attribute instance-attribute

DRAG_OVER = 'dragOver'

DROP class-attribute instance-attribute

DROP = 'drop'

DRAG_CANCEL class-attribute instance-attribute

DRAG_CANCEL = 'dragCancel'

KeyEventType

Bases: str, Enum

Key event types.

KEY_DOWN class-attribute instance-attribute

KEY_DOWN = 'keyDown'

KEY_UP class-attribute instance-attribute

KEY_UP = 'keyUp'

RAW_KEY_DOWN class-attribute instance-attribute

RAW_KEY_DOWN = 'rawKeyDown'

CHAR class-attribute instance-attribute

CHAR = 'char'

MouseEventType

Bases: str, Enum

Mouse event types.

MOUSE_PRESSED class-attribute instance-attribute

MOUSE_PRESSED = 'mousePressed'

MOUSE_RELEASED class-attribute instance-attribute

MOUSE_RELEASED = 'mouseReleased'

MOUSE_MOVED class-attribute instance-attribute

MOUSE_MOVED = 'mouseMoved'

MOUSE_WHEEL class-attribute instance-attribute

MOUSE_WHEEL = 'mouseWheel'

TouchEventType

Bases: str, Enum

Touch event types.

TOUCH_START class-attribute instance-attribute

TOUCH_START = 'touchStart'

TOUCH_END class-attribute instance-attribute

TOUCH_END = 'touchEnd'

TOUCH_MOVE class-attribute instance-attribute

TOUCH_MOVE = 'touchMove'

TOUCH_CANCEL class-attribute instance-attribute

TOUCH_CANCEL = 'touchCancel'

KeyModifier

Bases: int, Enum

ALT class-attribute instance-attribute

ALT = 1

CTRL class-attribute instance-attribute

CTRL = 2

META class-attribute instance-attribute

META = 4

SHIFT class-attribute instance-attribute

SHIFT = 8

KeyLocation

Bases: int, Enum

LEFT class-attribute instance-attribute

LEFT = 1

RIGHT class-attribute instance-attribute

RIGHT = 2

PointerType

Bases: str, Enum

Pointer types.

MOUSE class-attribute instance-attribute

MOUSE = 'mouse'

PEN class-attribute instance-attribute

PEN = 'pen'

TouchPoint

Bases: TypedDict

Touch point data.

x instance-attribute

x

y instance-attribute

y

radiusX instance-attribute

radiusX

radiusY instance-attribute

radiusY

rotationAngle instance-attribute

rotationAngle

force instance-attribute

force

tangentialPressure instance-attribute

tangentialPressure

tiltX instance-attribute

tiltX

tiltY instance-attribute

tiltY

twist instance-attribute

twist

id instance-attribute

id

DragDataItem

Bases: TypedDict

Drag data item.

mimeType instance-attribute

mimeType

data instance-attribute

data

title instance-attribute

title

baseURL instance-attribute

baseURL

DragData

Bases: TypedDict

Drag data.

items instance-attribute

items

dragOperationsMask instance-attribute

dragOperationsMask

files instance-attribute

files