chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.input/InputDomain

InputDomain

class InputDomain(source)

Functions

suspend fun cancelDragging(): CancelDraggingResponse

Cancels any active dragging in the page.

dispatchDragEvent

suspend fun dispatchDragEvent(input: DispatchDragEventRequest): DispatchDragEventResponse

inline suspend fun dispatchDragEvent(type: DragEventType, x: Double, y: Double, data: DragData, optionalArgs: DispatchDragEventRequest.Builder.() -> Unit = {}): DispatchDragEventResponse

Dispatches a drag event into the page.

dispatchKeyEvent

suspend fun dispatchKeyEvent(input: DispatchKeyEventRequest): DispatchKeyEventResponse

inline suspend fun dispatchKeyEvent(type: KeyEventType, optionalArgs: DispatchKeyEventRequest.Builder.() -> Unit = {}): DispatchKeyEventResponse

Dispatches a key event to the page.

dispatchMouseClick

suspend fun InputDomain.dispatchMouseClick(x: Double, y: Double, clickDurationMillis: Long = 100, button: MouseButton = MouseButton.left)

Simulates a mouse click on the given x and y coordinates. This uses a mousePressed and mouseReleased event in quick succession.

dispatchMouseEvent

suspend fun dispatchMouseEvent(input: DispatchMouseEventRequest): DispatchMouseEventResponse

inline suspend fun dispatchMouseEvent(type: MouseEventType, x: Double, y: Double, optionalArgs: DispatchMouseEventRequest.Builder.() -> Unit = {}): DispatchMouseEventResponse

Dispatches a mouse event to the page.

dispatchTouchEvent

suspend fun dispatchTouchEvent(input: DispatchTouchEventRequest): DispatchTouchEventResponse

inline suspend fun dispatchTouchEvent(type: TouchEventType, touchPoints: List<TouchPoint>, optionalArgs: DispatchTouchEventRequest.Builder.() -> Unit = {}): DispatchTouchEventResponse

Dispatches a touch event to the page.

dragIntercepted

fun ~~dragIntercepted~~(): Flow<InputEvent.DragIntercepted>

dragInterceptedEvents

fun dragInterceptedEvents(): Flow<InputEvent.DragIntercepted>

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

emulateTouchFromMouseEvent

suspend fun emulateTouchFromMouseEvent(input: EmulateTouchFromMouseEventRequest): EmulateTouchFromMouseEventResponse

inline suspend fun emulateTouchFromMouseEvent(type: MouseEventType, x: Int, y: Int, button: MouseButton, optionalArgs: EmulateTouchFromMouseEventRequest.Builder.() -> Unit = {}): EmulateTouchFromMouseEventResponse

Emulates touch event from the mouse event parameters.

fun events(): Flow<InputEvent>

Subscribes to all events related to this domain.

imeSetComposition

suspend fun imeSetComposition(input: ImeSetCompositionRequest): ImeSetCompositionResponse

inline suspend fun imeSetComposition(text: String, selectionStart: Int, selectionEnd: Int, optionalArgs: ImeSetCompositionRequest.Builder.() -> Unit = {}): ImeSetCompositionResponse

This method sets the current candidate text for ime. Use imeCommitComposition to commit the final text. Use imeSetComposition with empty string as text to cancel composition.

suspend fun insertText(text: String): InsertTextResponse

suspend fun insertText(input: InsertTextRequest): InsertTextResponse

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

setIgnoreInputEvents

suspend fun setIgnoreInputEvents(ignore: Boolean): SetIgnoreInputEventsResponse

suspend fun setIgnoreInputEvents(input: SetIgnoreInputEventsRequest): SetIgnoreInputEventsResponse

Ignores input events (useful while auditing page).

setInterceptDrags

suspend fun setInterceptDrags(enabled: Boolean): SetInterceptDragsResponse

suspend fun setInterceptDrags(input: SetInterceptDragsRequest): SetInterceptDragsResponse

Prevents default drag and drop behavior and instead emits Input.dragIntercepted events. Drag and drop behavior can be directly controlled via Input.dispatchDragEvent.

synthesizePinchGesture

suspend fun synthesizePinchGesture(input: SynthesizePinchGestureRequest): SynthesizePinchGestureResponse

inline suspend fun synthesizePinchGesture(x: Double, y: Double, scaleFactor: Double, optionalArgs: SynthesizePinchGestureRequest.Builder.() -> Unit = {}): SynthesizePinchGestureResponse

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

synthesizeScrollGesture

suspend fun synthesizeScrollGesture(input: SynthesizeScrollGestureRequest): SynthesizeScrollGestureResponse

inline suspend fun synthesizeScrollGesture(x: Double, y: Double, optionalArgs: SynthesizeScrollGestureRequest.Builder.() -> Unit = {}): SynthesizeScrollGestureResponse

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

synthesizeTapGesture

suspend fun synthesizeTapGesture(input: SynthesizeTapGestureRequest): SynthesizeTapGestureResponse

inline suspend fun synthesizeTapGesture(x: Double, y: Double, optionalArgs: SynthesizeTapGestureRequest.Builder.() -> Unit = {}): SynthesizeTapGestureResponse

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