Class SetClientHintsOverrideCommandParameters

Namespace

WebDriverBiDi.UserAgentClientHints

Assembly

WebDriverBiDi.dll

Provides parameters for the userAgentClientHints.setClientHintsOverride command.

public class SetClientHintsOverrideCommandParameters : CommandParameters<SetClientHintsOverrideCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetClientHintsOverrideCommandResult>

SetClientHintsOverrideCommandParameters

Inherited Members

CommandParameters<SetClientHintsOverrideCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SetClientHintsOverrideCommandParameters()

Initializes a new instance of the SetClientHintsOverrideCommandParameters class.

public SetClientHintsOverrideCommandParameters()

Properties

ClientHints

Gets or sets the client hints to override. When null, clears the override.

[JsonPropertyName("clientHints")]
public ClientHintsMetadata? ClientHints { get; set; }

Property Value

ClientHintsMetadata

Contexts

Gets the browsing contexts for which to set the client hints override.

[JsonIgnore]
public List<string> Contexts { get; }

Property Value

List<string>

Remarks

The protocol requires this property, when present, to contain at least one entry. An empty list therefore means "not specified": the property is omitted from the JSON payload entirely, and an empty array is never sent. Add entries to the list to scope the command.

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

ResetClientHintsOverride

Gets a pre-initialized instance of SetClientHintsOverrideCommandParameters with the ClientHints property set to null to clear any existing client hints override. Returns a new instance on each access to allow for modification of the properties without affecting other uses. Functionally equivalent to using the parameterless constructor, but provided as a named property to make the intent of clearing the override more explicit in code that uses this property.

public static SetClientHintsOverrideCommandParameters ResetClientHintsOverride { get; }

Property Value

SetClientHintsOverrideCommandParameters

UserContexts

Gets the user contexts for which to set the client hints override.

[JsonIgnore]
public List<string> UserContexts { get; }

Property Value

List<string>

Remarks

The protocol requires this property, when present, to contain at least one entry. An empty list therefore means "not specified": the property is omitted from the JSON payload entirely, and an empty array is never sent. Add entries to the list to scope the command.