Class SetNetworkConditionsCommandParameters

Namespace

WebDriverBiDi.Emulation

Assembly

WebDriverBiDi.dll

Provides parameters for the emulation.setNetworkConditions command.

public class SetNetworkConditionsCommandParameters : CommandParameters<SetNetworkConditionsCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetNetworkConditionsCommandResult>

SetNetworkConditionsCommandParameters

Inherited Members

CommandParameters<SetNetworkConditionsCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SetNetworkConditionsCommandParameters()

Initializes a new instance of the SetNetworkConditionsCommandParameters class.

public SetNetworkConditionsCommandParameters()

Properties

Contexts

Gets the browsing contexts for which to set the emulated network conditions.

[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

NetworkConditions

Gets or sets the network conditions to emulate. When null, clears the emulated network conditions.

[JsonPropertyName("networkConditions")]
public NetworkConditions? NetworkConditions { get; set; }

Property Value

NetworkConditions

ResetNetworkConditions

Gets a pre-initialized instance of SetNetworkConditionsCommandParameters with the NetworkConditions property set to null to clear any existing network conditions. 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 SetNetworkConditionsCommandParameters ResetNetworkConditions { get; }

Property Value

SetNetworkConditionsCommandParameters

UserContexts

Gets the user contexts for which to set the emulated network conditions.

[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.