Class ProfilerAdapter

Namespace

OpenQA.Selenium.DevTools.V134.Profiler

Assembly

WebDriver.dll

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

public class ProfilerAdapter

Inheritance

object

ProfilerAdapter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ProfilerAdapter(IDevToolsSession)

Initializes a new instance of the ProfilerAdapter class.

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

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>

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>

GetBestEffortCoverage(GetBestEffortCoverageCommandSettings?, CancellationToken, int?, bool)

getBestEffortCoverage

public Task<GetBestEffortCoverageCommandResponse> GetBestEffortCoverage(GetBestEffortCoverageCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetBestEffortCoverageCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<GetBestEffortCoverageCommandResponse>

SetSamplingInterval(SetSamplingIntervalCommandSettings, CancellationToken, int?, bool)

setSamplingInterval

public Task<SetSamplingIntervalCommandResponse?> SetSamplingInterval(SetSamplingIntervalCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetSamplingIntervalCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetSamplingIntervalCommandResponse>

Start(StartCommandSettings?, CancellationToken, int?, bool)

start

public Task<StartCommandResponse?> Start(StartCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StartCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StartCommandResponse>

StartPreciseCoverage(StartPreciseCoverageCommandSettings, CancellationToken, int?, bool)

startPreciseCoverage

public Task<StartPreciseCoverageCommandResponse> StartPreciseCoverage(StartPreciseCoverageCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StartPreciseCoverageCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StartPreciseCoverageCommandResponse>

Stop(StopCommandSettings?, CancellationToken, int?, bool)

stop

public Task<StopCommandResponse> Stop(StopCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StopCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StopCommandResponse>

StopPreciseCoverage(StopPreciseCoverageCommandSettings?, CancellationToken, int?, bool)

stopPreciseCoverage

public Task<StopPreciseCoverageCommandResponse?> StopPreciseCoverage(StopPreciseCoverageCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StopPreciseCoverageCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StopPreciseCoverageCommandResponse>

TakePreciseCoverage(TakePreciseCoverageCommandSettings?, CancellationToken, int?, bool)

takePreciseCoverage

public Task<TakePreciseCoverageCommandResponse> TakePreciseCoverage(TakePreciseCoverageCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command TakePreciseCoverageCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<TakePreciseCoverageCommandResponse>

Events

ConsoleProfileFinished

consoleProfileFinished

public event EventHandler<ConsoleProfileFinishedEventArgs>? ConsoleProfileFinished

Event Type

EventHandler<ConsoleProfileFinishedEventArgs>

ConsoleProfileStarted

consoleProfileStarted

public event EventHandler<ConsoleProfileStartedEventArgs>? ConsoleProfileStarted

Event Type

EventHandler<ConsoleProfileStartedEventArgs>

PreciseCoverageDeltaUpdate

preciseCoverageDeltaUpdate

public event EventHandler<PreciseCoverageDeltaUpdateEventArgs>? PreciseCoverageDeltaUpdate

Event Type

EventHandler<PreciseCoverageDeltaUpdateEventArgs>