Class SetGeolocationOverrideCommandParameters

Namespace

WebDriverBiDi.Emulation

Assembly

WebDriverBiDi.dll

Provides parameters for the emulation.setGeolocationOverride command.

public class SetGeolocationOverrideCommandParameters : CommandParameters<SetGeolocationOverrideCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetGeolocationOverrideCommandResult>

SetGeolocationOverrideCommandParameters

Derived

SetGeolocationOverrideCoordinatesCommandParameters

SetGeolocationOverrideErrorCommandParameters

Inherited Members

CommandParameters<SetGeolocationOverrideCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SetGeolocationOverrideCommandParameters()

Initializes a new instance of the SetGeolocationOverrideCommandParameters class.

protected SetGeolocationOverrideCommandParameters()

Properties

Contexts

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

ResetGeolocationOverride

Gets a pre-initialized instance of SetGeolocationOverrideCoordinatesCommandParameters with the Coordinates property set to null to clear any existing geolocation 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 of SetGeolocationOverrideCoordinatesCommandParameters, but provided as a named property to make the intent of clearing the override more explicit in code that uses this property.

public static SetGeolocationOverrideCoordinatesCommandParameters ResetGeolocationOverride { get; }

Property Value

SetGeolocationOverrideCoordinatesCommandParameters

UserContexts

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