Interface IServiceWorker

Namespace

Selenium.WebDriver.BiDi.Cdp.ServiceWorker

Assembly

Selenium.WebDriver.BiDi.Cdp.dll

[Experimental("BIDICDP001")]
public interface IServiceWorker

Properties

WorkerErrorReported

IEventSource<WorkerErrorReportedEventArgs> WorkerErrorReported { get; }

Property Value

IEventSource<WorkerErrorReportedEventArgs>

Remarks

Event args (WorkerErrorReportedEventArgs):

• ErrorMessage

WorkerRegistrationUpdated

IEventSource<WorkerRegistrationUpdatedEventArgs> WorkerRegistrationUpdated { get; }

Property Value

IEventSource<WorkerRegistrationUpdatedEventArgs>

Remarks

Event args (WorkerRegistrationUpdatedEventArgs):

• Registrations

WorkerVersionUpdated

IEventSource<WorkerVersionUpdatedEventArgs> WorkerVersionUpdated { get; }

Property Value

IEventSource<WorkerVersionUpdatedEventArgs>

Remarks

Event args (WorkerVersionUpdatedEventArgs):

• Versions

Methods

DeliverPushMessageAsync(string, RegistrationID, string, string?, CancellationToken)

Task<DeliverPushMessageResult> DeliverPushMessageAsync(string origin, RegistrationID registrationId, string data, string? session = null, CancellationToken cancellationToken = default)

Parameters

origin string

registrationId RegistrationID

data string

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DeliverPushMessageResult>

A task representing the asynchronous operation, containing a DeliverPushMessageResult.

DisableAsync(string?, CancellationToken)

Task<DisableResult> DisableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DisableResult>

A task representing the asynchronous operation, containing a DisableResult.

DispatchPeriodicSyncEventAsync(string, RegistrationID, string, string?, CancellationToken)

Task<DispatchPeriodicSyncEventResult> DispatchPeriodicSyncEventAsync(string origin, RegistrationID registrationId, string tag, string? session = null, CancellationToken cancellationToken = default)

Parameters

origin string

registrationId RegistrationID

tag string

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DispatchPeriodicSyncEventResult>

A task representing the asynchronous operation, containing a DispatchPeriodicSyncEventResult.

DispatchSyncEventAsync(string, RegistrationID, string, bool, string?, CancellationToken)

Task<DispatchSyncEventResult> DispatchSyncEventAsync(string origin, RegistrationID registrationId, string tag, bool lastChance, string? session = null, CancellationToken cancellationToken = default)

Parameters

origin string

registrationId RegistrationID

tag string

lastChance bool

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DispatchSyncEventResult>

A task representing the asynchronous operation, containing a DispatchSyncEventResult.

EnableAsync(string?, CancellationToken)

Task<EnableResult> EnableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<EnableResult>

A task representing the asynchronous operation, containing a EnableResult.

SetForceUpdateOnPageLoadAsync(bool, string?, CancellationToken)

Task<SetForceUpdateOnPageLoadResult> SetForceUpdateOnPageLoadAsync(bool forceUpdateOnPageLoad, string? session = null, CancellationToken cancellationToken = default)

Parameters

forceUpdateOnPageLoad bool

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetForceUpdateOnPageLoadResult>

A task representing the asynchronous operation, containing a SetForceUpdateOnPageLoadResult.

SkipWaitingAsync(string, string?, CancellationToken)

Task<SkipWaitingResult> SkipWaitingAsync(string scopeURL, string? session = null, CancellationToken cancellationToken = default)

Parameters

scopeURL string

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SkipWaitingResult>

A task representing the asynchronous operation, containing a SkipWaitingResult.

StartWorkerAsync(string, string?, CancellationToken)

Task<StartWorkerResult> StartWorkerAsync(string scopeURL, string? session = null, CancellationToken cancellationToken = default)

Parameters

scopeURL string

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<StartWorkerResult>

A task representing the asynchronous operation, containing a StartWorkerResult.

StopAllWorkersAsync(string?, CancellationToken)

Task<StopAllWorkersResult> StopAllWorkersAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<StopAllWorkersResult>

A task representing the asynchronous operation, containing a StopAllWorkersResult.

StopWorkerAsync(string, string?, CancellationToken)

Task<StopWorkerResult> StopWorkerAsync(string versionId, string? session = null, CancellationToken cancellationToken = default)

Parameters

versionId string

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<StopWorkerResult>

A task representing the asynchronous operation, containing a StopWorkerResult.

UnregisterAsync(string, string?, CancellationToken)

Task<UnregisterResult> UnregisterAsync(string scopeURL, string? session = null, CancellationToken cancellationToken = default)

Parameters

scopeURL string

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<UnregisterResult>

A task representing the asynchronous operation, containing a UnregisterResult.

UpdateRegistrationAsync(string, string?, CancellationToken)

Task<UpdateRegistrationResult> UpdateRegistrationAsync(string scopeURL, string? session = null, CancellationToken cancellationToken = default)

Parameters

scopeURL string

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<UpdateRegistrationResult>

A task representing the asynchronous operation, containing a UpdateRegistrationResult.