Table of Contents

Class RuntimeAdapter

Namespace
OpenQA.Selenium.DevTools.V142.Runtime
Assembly
WebDriver.dll

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

public class RuntimeAdapter
Inheritance
RuntimeAdapter
Inherited Members

Constructors

RuntimeAdapter(IDevToolsSession)

Initializes a new instance of the RuntimeAdapter class.

public RuntimeAdapter(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

AddBinding(AddBindingCommandSettings, CancellationToken, int?, bool)

addBinding

public Task<AddBindingCommandResponse?> AddBinding(AddBindingCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command AddBindingCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<AddBindingCommandResponse>

AwaitPromise(AwaitPromiseCommandSettings, CancellationToken, int?, bool)

awaitPromise

public Task<AwaitPromiseCommandResponse> AwaitPromise(AwaitPromiseCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command AwaitPromiseCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<AwaitPromiseCommandResponse>

CallFunctionOn(CallFunctionOnCommandSettings, CancellationToken, int?, bool)

callFunctionOn

public Task<CallFunctionOnCommandResponse> CallFunctionOn(CallFunctionOnCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command CallFunctionOnCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<CallFunctionOnCommandResponse>

CompileScript(CompileScriptCommandSettings, CancellationToken, int?, bool)

compileScript

public Task<CompileScriptCommandResponse> CompileScript(CompileScriptCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command CompileScriptCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<CompileScriptCommandResponse>

Disable(DisableCommandSettings?, CancellationToken, int?, bool)

disable

public Task<DisableCommandResponse?> Disable(DisableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DisableCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<DisableCommandResponse>

DiscardConsoleEntries(DiscardConsoleEntriesCommandSettings?, CancellationToken, int?, bool)

discardConsoleEntries

public Task<DiscardConsoleEntriesCommandResponse?> DiscardConsoleEntries(DiscardConsoleEntriesCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DiscardConsoleEntriesCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<DiscardConsoleEntriesCommandResponse>

Enable(EnableCommandSettings?, CancellationToken, int?, bool)

enable

public Task<EnableCommandResponse?> Enable(EnableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command EnableCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<EnableCommandResponse>

Evaluate(EvaluateCommandSettings, CancellationToken, int?, bool)

evaluate

public Task<EvaluateCommandResponse> Evaluate(EvaluateCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command EvaluateCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<EvaluateCommandResponse>

GetExceptionDetails(GetExceptionDetailsCommandSettings, CancellationToken, int?, bool)

getExceptionDetails

public Task<GetExceptionDetailsCommandResponse> GetExceptionDetails(GetExceptionDetailsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetExceptionDetailsCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<GetExceptionDetailsCommandResponse>

GetHeapUsage(GetHeapUsageCommandSettings?, CancellationToken, int?, bool)

getHeapUsage

public Task<GetHeapUsageCommandResponse> GetHeapUsage(GetHeapUsageCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetHeapUsageCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<GetHeapUsageCommandResponse>

GetIsolateId(GetIsolateIdCommandSettings?, CancellationToken, int?, bool)

getIsolateId

public Task<GetIsolateIdCommandResponse> GetIsolateId(GetIsolateIdCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetIsolateIdCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<GetIsolateIdCommandResponse>

GetProperties(GetPropertiesCommandSettings, CancellationToken, int?, bool)

getProperties

public Task<GetPropertiesCommandResponse> GetProperties(GetPropertiesCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetPropertiesCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<GetPropertiesCommandResponse>

GlobalLexicalScopeNames(GlobalLexicalScopeNamesCommandSettings, CancellationToken, int?, bool)

globalLexicalScopeNames

public Task<GlobalLexicalScopeNamesCommandResponse> GlobalLexicalScopeNames(GlobalLexicalScopeNamesCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GlobalLexicalScopeNamesCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<GlobalLexicalScopeNamesCommandResponse>

QueryObjects(QueryObjectsCommandSettings, CancellationToken, int?, bool)

queryObjects

public Task<QueryObjectsCommandResponse> QueryObjects(QueryObjectsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command QueryObjectsCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<QueryObjectsCommandResponse>

ReleaseObject(ReleaseObjectCommandSettings, CancellationToken, int?, bool)

releaseObject

public Task<ReleaseObjectCommandResponse?> ReleaseObject(ReleaseObjectCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReleaseObjectCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<ReleaseObjectCommandResponse>

ReleaseObjectGroup(ReleaseObjectGroupCommandSettings, CancellationToken, int?, bool)

releaseObjectGroup

public Task<ReleaseObjectGroupCommandResponse?> ReleaseObjectGroup(ReleaseObjectGroupCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReleaseObjectGroupCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<ReleaseObjectGroupCommandResponse>

RemoveBinding(RemoveBindingCommandSettings, CancellationToken, int?, bool)

removeBinding

public Task<RemoveBindingCommandResponse?> RemoveBinding(RemoveBindingCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command RemoveBindingCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<RemoveBindingCommandResponse>

RunIfWaitingForDebugger(RunIfWaitingForDebuggerCommandSettings?, CancellationToken, int?, bool)

runIfWaitingForDebugger

public Task<RunIfWaitingForDebuggerCommandResponse?> RunIfWaitingForDebugger(RunIfWaitingForDebuggerCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command RunIfWaitingForDebuggerCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<RunIfWaitingForDebuggerCommandResponse>

RunScript(RunScriptCommandSettings, CancellationToken, int?, bool)

runScript

public Task<RunScriptCommandResponse> RunScript(RunScriptCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command RunScriptCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<RunScriptCommandResponse>

SetAsyncCallStackDepth(SetAsyncCallStackDepthCommandSettings, CancellationToken, int?, bool)

setAsyncCallStackDepth

public Task<SetAsyncCallStackDepthCommandResponse?> SetAsyncCallStackDepth(SetAsyncCallStackDepthCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetAsyncCallStackDepthCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<SetAsyncCallStackDepthCommandResponse>

SetCustomObjectFormatterEnabled(SetCustomObjectFormatterEnabledCommandSettings, CancellationToken, int?, bool)

setCustomObjectFormatterEnabled

public Task<SetCustomObjectFormatterEnabledCommandResponse?> SetCustomObjectFormatterEnabled(SetCustomObjectFormatterEnabledCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetCustomObjectFormatterEnabledCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<SetCustomObjectFormatterEnabledCommandResponse>

SetMaxCallStackSizeToCapture(SetMaxCallStackSizeToCaptureCommandSettings, CancellationToken, int?, bool)

setMaxCallStackSizeToCapture

public Task<SetMaxCallStackSizeToCaptureCommandResponse?> SetMaxCallStackSizeToCapture(SetMaxCallStackSizeToCaptureCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetMaxCallStackSizeToCaptureCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<SetMaxCallStackSizeToCaptureCommandResponse>

TerminateExecution(TerminateExecutionCommandSettings?, CancellationToken, int?, bool)

terminateExecution

public Task<TerminateExecutionCommandResponse?> TerminateExecution(TerminateExecutionCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command TerminateExecutionCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<TerminateExecutionCommandResponse>

Events

BindingCalled

bindingCalled

public event EventHandler<BindingCalledEventArgs>? BindingCalled

Event Type

EventHandler<BindingCalledEventArgs>

ConsoleAPICalled

consoleAPICalled

public event EventHandler<ConsoleAPICalledEventArgs>? ConsoleAPICalled

Event Type

EventHandler<ConsoleAPICalledEventArgs>

ExceptionRevoked

exceptionRevoked

public event EventHandler<ExceptionRevokedEventArgs>? ExceptionRevoked

Event Type

EventHandler<ExceptionRevokedEventArgs>

ExceptionThrown

exceptionThrown

public event EventHandler<ExceptionThrownEventArgs>? ExceptionThrown

Event Type

EventHandler<ExceptionThrownEventArgs>

ExecutionContextCreated

executionContextCreated

public event EventHandler<ExecutionContextCreatedEventArgs>? ExecutionContextCreated

Event Type

EventHandler<ExecutionContextCreatedEventArgs>

ExecutionContextDestroyed

executionContextDestroyed

public event EventHandler<ExecutionContextDestroyedEventArgs>? ExecutionContextDestroyed

Event Type

EventHandler<ExecutionContextDestroyedEventArgs>

ExecutionContextsCleared

executionContextsCleared

public event EventHandler<ExecutionContextsClearedEventArgs>? ExecutionContextsCleared

Event Type

EventHandler<ExecutionContextsClearedEventArgs>

InspectRequested

inspectRequested

public event EventHandler<InspectRequestedEventArgs>? InspectRequested

Event Type

EventHandler<InspectRequestedEventArgs>
Edit this page