Class SetUserAgentOverrideCommandParameters

Namespace

WebDriverBiDi.Emulation

Assembly

WebDriverBiDi.dll

Provides parameters for the emulation.setUserAgentOverride command.

public class SetUserAgentOverrideCommandParameters : CommandParameters<SetUserAgentOverrideCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetUserAgentOverrideCommandResult>

SetUserAgentOverrideCommandParameters

Inherited Members

CommandParameters<SetUserAgentOverrideCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SetUserAgentOverrideCommandParameters()

Initializes a new instance of the SetUserAgentOverrideCommandParameters class.

public SetUserAgentOverrideCommandParameters()

Properties

Contexts

Gets the browsing contexts for which to set the user agent 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.

The two scopes are mutually exclusive: a command that names both browsing contexts and user contexts is rejected by the remote end with an invalid argument error. Scope the command one way or the other.

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

ResetUserAgentOverride

Gets a pre-initialized instance of SetUserAgentOverrideCommandParameters with the UserAgent property set to null to clear any existing user agent 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 SetUserAgentOverrideCommandParameters ResetUserAgentOverride { get; }

Property Value

SetUserAgentOverrideCommandParameters

UserAgent

Gets or sets the user agent string for the browser. When null, clears the override.

[JsonPropertyName("userAgent")]
public string? UserAgent { get; set; }

Property Value

string

UserContexts

Gets the user contexts for which to set the user agent 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.

The two scopes are mutually exclusive: a command that names both browsing contexts and user contexts is rejected by the remote end with an invalid argument error. Scope the command one way or the other.