Class InputAdapter

Namespace

OpenQA.Selenium.DevTools.V143.Input

Assembly

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)

cancelDragging

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)

dispatchDragEvent

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)

dispatchKeyEvent

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)

dispatchMouseEvent

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)

dispatchTouchEvent

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)

emulateTouchFromMouseEvent

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)

imeSetComposition

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)

insertText

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)

setIgnoreInputEvents

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)

setInterceptDrags

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)

synthesizePinchGesture

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)

synthesizeScrollGesture

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)

synthesizeTapGesture

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

dragIntercepted

public event EventHandler<DragInterceptedEventArgs>? DragIntercepted

Event Type

EventHandler<DragInterceptedEventArgs>