Class UserAgentClientHintsModule

Namespace

WebDriverBiDi.UserAgentClientHints

Assembly

WebDriverBiDi.dll

The UserAgentClientHints module contains commands for managing user agent client hints.

public sealed class UserAgentClientHintsModule : Module

Inheritance

object

Module

UserAgentClientHintsModule

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

UserAgentClientHintsModule(IBiDiModuleHost)

Initializes a new instance of the UserAgentClientHintsModule class.

public UserAgentClientHintsModule(IBiDiModuleHost driver)

Parameters

driver IBiDiModuleHost

The IBiDiModuleHost used in the module commands and events.

Fields

UserAgentClientHintsModuleName

The name of the userAgentClientHints module.

public const string UserAgentClientHintsModuleName = "userAgentClientHints"

Field Value

string

Properties

ModuleName

Gets the module name.

public override string ModuleName { get; }

Property Value

string

Methods

SetClientHintsOverrideAsync(SetClientHintsOverrideCommandParameters, TimeSpan?, CancellationToken)

Sets overrides for the user agent client hints.

public Task<SetClientHintsOverrideCommandResult> SetClientHintsOverrideAsync(SetClientHintsOverrideCommandParameters commandParameters, TimeSpan? timeoutOverride = null, CancellationToken cancellationToken = default)

Parameters

commandParameters SetClientHintsOverrideCommandParameters

The parameters for the command.

timeoutOverride TimeSpan?

The timeout override to use for the command. If omitted, the value of DefaultCommandTimeout is used.

cancellationToken CancellationToken

A cancellation token used to propagate notification that the operation should be canceled. Omitting this argument is the equivalent of using None.

Returns

Task<SetClientHintsOverrideCommandResult>

An empty command result.

Exceptions

ArgumentNullException

Thrown when commandParameters is null.

ArgumentOutOfRangeException

Thrown when timeoutOverride is negative (other than InfiniteTimeSpan) or exceeds the maximum supported timer duration.

WebDriverBiDiCommandException

Thrown when the remote end returns an error response for the command.

WebDriverBiDiSerializationException

Thrown when the command parameters cannot be serialized, or the response cannot be deserialized.

WebDriverBiDiTimeoutException

Thrown when the command does not complete within the timeout.

WebDriverBiDiConnectionException

Thrown when the driver is not connected to a remote end, or the connection is lost before the command completes.

WebDriverBiDiException

Thrown when the command is canceled, or its response carries no result or a result of the wrong type.

OperationCanceledException

Thrown when cancellationToken is canceled.

ObjectDisposedException

Thrown when the driver has been disposed.