Class InputAdapter

Namespace

OpenQA.Selenium.DevTools.V148.Input

Assembly

Selenium.WebDriver.dll

Represents an adapter for the Input domain to simplify the command interface.

public class InputAdapter

Inheritance

object

InputAdapter

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

InputAdapter(IDevToolsSession)

Initializes a new instance of the InputAdapter class.

public InputAdapter(IDevToolsSession session)

Parameters

session IDevToolsSession

The IDevToolsSession to be used with this adapter.

Exceptions

ArgumentNullException

If session is null.

Properties

Session

Gets the DevToolsSession associated with the adapter.

public IDevToolsSession Session { get; }

Property Value

IDevToolsSession

Methods

CancelDragging(CancelDraggingCommandSettings?, CancellationToken, int?, bool)

Cancels any active dragging in the page.

public Task<CancelDraggingCommandResponse?> CancelDragging(CancelDraggingCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command CancelDraggingCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<CancelDraggingCommandResponse>

DispatchDragEvent(DispatchDragEventCommandSettings, CancellationToken, int?, bool)

Dispatches a drag event into the page.

public Task<DispatchDragEventCommandResponse?> DispatchDragEvent(DispatchDragEventCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DispatchDragEventCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DispatchDragEventCommandResponse>

DispatchKeyEvent(DispatchKeyEventCommandSettings, CancellationToken, int?, bool)

Dispatches a key event to the page.

public Task<DispatchKeyEventCommandResponse?> DispatchKeyEvent(DispatchKeyEventCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DispatchKeyEventCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DispatchKeyEventCommandResponse>

DispatchMouseEvent(DispatchMouseEventCommandSettings, CancellationToken, int?, bool)

Dispatches a mouse event to the page.

public Task<DispatchMouseEventCommandResponse?> DispatchMouseEvent(DispatchMouseEventCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DispatchMouseEventCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DispatchMouseEventCommandResponse>

DispatchTouchEvent(DispatchTouchEventCommandSettings, CancellationToken, int?, bool)

Dispatches a touch event to the page.

public Task<DispatchTouchEventCommandResponse?> DispatchTouchEvent(DispatchTouchEventCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DispatchTouchEventCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DispatchTouchEventCommandResponse>

EmulateTouchFromMouseEvent(EmulateTouchFromMouseEventCommandSettings, CancellationToken, int?, bool)

Emulates touch event from the mouse event parameters.

public Task<EmulateTouchFromMouseEventCommandResponse?> EmulateTouchFromMouseEvent(EmulateTouchFromMouseEventCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command EmulateTouchFromMouseEventCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<EmulateTouchFromMouseEventCommandResponse>

ImeSetComposition(ImeSetCompositionCommandSettings, CancellationToken, int?, bool)

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.

public Task<ImeSetCompositionCommandResponse?> ImeSetComposition(ImeSetCompositionCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ImeSetCompositionCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ImeSetCompositionCommandResponse>

InsertText(InsertTextCommandSettings, CancellationToken, int?, bool)

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

public Task<InsertTextCommandResponse?> InsertText(InsertTextCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command InsertTextCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<InsertTextCommandResponse>

SetIgnoreInputEvents(SetIgnoreInputEventsCommandSettings, CancellationToken, int?, bool)

Ignores input events (useful while auditing page).

public Task<SetIgnoreInputEventsCommandResponse?> SetIgnoreInputEvents(SetIgnoreInputEventsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetIgnoreInputEventsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetIgnoreInputEventsCommandResponse>

SetInterceptDrags(SetInterceptDragsCommandSettings, CancellationToken, int?, bool)

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

public Task<SetInterceptDragsCommandResponse?> SetInterceptDrags(SetInterceptDragsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetInterceptDragsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetInterceptDragsCommandResponse>

SynthesizePinchGesture(SynthesizePinchGestureCommandSettings, CancellationToken, int?, bool)

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

public Task<SynthesizePinchGestureCommandResponse?> SynthesizePinchGesture(SynthesizePinchGestureCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SynthesizePinchGestureCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SynthesizePinchGestureCommandResponse>

SynthesizeScrollGesture(SynthesizeScrollGestureCommandSettings, CancellationToken, int?, bool)

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

public Task<SynthesizeScrollGestureCommandResponse?> SynthesizeScrollGesture(SynthesizeScrollGestureCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SynthesizeScrollGestureCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SynthesizeScrollGestureCommandResponse>

SynthesizeTapGesture(SynthesizeTapGestureCommandSettings, CancellationToken, int?, bool)

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

public Task<SynthesizeTapGestureCommandResponse?> SynthesizeTapGesture(SynthesizeTapGestureCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SynthesizeTapGestureCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SynthesizeTapGestureCommandResponse>

Events

DragIntercepted

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

public event EventHandler<DragInterceptedEventArgs>? DragIntercepted

Event Type

EventHandler<DragInterceptedEventArgs>