Class ServiceWorkerAdapter

Namespace

OpenQA.Selenium.DevTools.V141.ServiceWorker

Assembly

WebDriver.dll

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

public class ServiceWorkerAdapter

Inheritance

object

ServiceWorkerAdapter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ServiceWorkerAdapter(IDevToolsSession)

Initializes a new instance of the ServiceWorkerAdapter class.

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

DeliverPushMessage(DeliverPushMessageCommandSettings, CancellationToken, int?, bool)

deliverPushMessage

public Task<DeliverPushMessageCommandResponse?> DeliverPushMessage(DeliverPushMessageCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DeliverPushMessageCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DeliverPushMessageCommandResponse>

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>

DispatchPeriodicSyncEvent(DispatchPeriodicSyncEventCommandSettings, CancellationToken, int?, bool)

dispatchPeriodicSyncEvent

public Task<DispatchPeriodicSyncEventCommandResponse?> DispatchPeriodicSyncEvent(DispatchPeriodicSyncEventCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DispatchPeriodicSyncEventCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DispatchPeriodicSyncEventCommandResponse>

DispatchSyncEvent(DispatchSyncEventCommandSettings, CancellationToken, int?, bool)

dispatchSyncEvent

public Task<DispatchSyncEventCommandResponse?> DispatchSyncEvent(DispatchSyncEventCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DispatchSyncEventCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DispatchSyncEventCommandResponse>

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>

SetForceUpdateOnPageLoad(SetForceUpdateOnPageLoadCommandSettings, CancellationToken, int?, bool)

setForceUpdateOnPageLoad

public Task<SetForceUpdateOnPageLoadCommandResponse?> SetForceUpdateOnPageLoad(SetForceUpdateOnPageLoadCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetForceUpdateOnPageLoadCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetForceUpdateOnPageLoadCommandResponse>

SkipWaiting(SkipWaitingCommandSettings, CancellationToken, int?, bool)

skipWaiting

public Task<SkipWaitingCommandResponse?> SkipWaiting(SkipWaitingCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SkipWaitingCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SkipWaitingCommandResponse>

StartWorker(StartWorkerCommandSettings, CancellationToken, int?, bool)

startWorker

public Task<StartWorkerCommandResponse?> StartWorker(StartWorkerCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StartWorkerCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StartWorkerCommandResponse>

StopAllWorkers(StopAllWorkersCommandSettings?, CancellationToken, int?, bool)

stopAllWorkers

public Task<StopAllWorkersCommandResponse?> StopAllWorkers(StopAllWorkersCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StopAllWorkersCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StopAllWorkersCommandResponse>

StopWorker(StopWorkerCommandSettings, CancellationToken, int?, bool)

stopWorker

public Task<StopWorkerCommandResponse?> StopWorker(StopWorkerCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command StopWorkerCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<StopWorkerCommandResponse>

Unregister(UnregisterCommandSettings, CancellationToken, int?, bool)

unregister

public Task<UnregisterCommandResponse?> Unregister(UnregisterCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command UnregisterCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<UnregisterCommandResponse>

UpdateRegistration(UpdateRegistrationCommandSettings, CancellationToken, int?, bool)

updateRegistration

public Task<UpdateRegistrationCommandResponse?> UpdateRegistration(UpdateRegistrationCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command UpdateRegistrationCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<UpdateRegistrationCommandResponse>

Events

WorkerErrorReported

workerErrorReported

public event EventHandler<WorkerErrorReportedEventArgs>? WorkerErrorReported

Event Type

EventHandler<WorkerErrorReportedEventArgs>

WorkerRegistrationUpdated

workerRegistrationUpdated

public event EventHandler<WorkerRegistrationUpdatedEventArgs>? WorkerRegistrationUpdated

Event Type

EventHandler<WorkerRegistrationUpdatedEventArgs>

WorkerVersionUpdated

workerVersionUpdated

public event EventHandler<WorkerVersionUpdatedEventArgs>? WorkerVersionUpdated

Event Type

EventHandler<WorkerVersionUpdatedEventArgs>