Class SetLocaleOverrideCommandParameters

Namespace

WebDriverBiDi.Emulation

Assembly

WebDriverBiDi.dll

Provides parameters for the emulation.setLocaleOverride command.

public class SetLocaleOverrideCommandParameters : CommandParameters<SetLocaleOverrideCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetLocaleOverrideCommandResult>

SetLocaleOverrideCommandParameters

Inherited Members

CommandParameters<SetLocaleOverrideCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Unlike most emulation commands, this one has no global form: the specification requires the command to name a scope, so a call that leaves both Contexts and UserContexts empty is rejected with InvalidArgument. Add at least one browsing context or user context before executing the command. emulation.setNetworkConditions, by contrast, does accept an unscoped call, and applies the network conditions it was given as the session-wide default, applied to every context that has no per-context or per-user-context override; this command has no such default.

Constructors

SetLocaleOverrideCommandParameters()

Initializes a new instance of the SetLocaleOverrideCommandParameters class.

public SetLocaleOverrideCommandParameters()

Properties

Contexts

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

Locale

Gets or sets the emulated locale for the browser. The value should be a valid structurally correct locale tag (e.g., "en-US", "pt-BR", etc.). When null, clears the override.

[JsonPropertyName("locale")]
public string? Locale { get; set; }

Property Value

string

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

ResetLocaleOverride

Gets a pre-initialized instance of SetLocaleOverrideCommandParameters with the Locale property set to null to clear any existing locale 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 SetLocaleOverrideCommandParameters ResetLocaleOverride { get; }

Property Value

SetLocaleOverrideCommandParameters

UserContexts

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