Class SetMediaFeaturesOverrideCommandParameters

Namespace

WebDriverBiDi.Emulation

Assembly

WebDriverBiDi.dll

Provides parameters for the emulation.setMediaFeaturesOverride command.

public class SetMediaFeaturesOverrideCommandParameters : CommandParameters<SetMediaFeaturesOverrideCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetMediaFeaturesOverrideCommandResult>

SetMediaFeaturesOverrideCommandParameters

Inherited Members

CommandParameters<SetMediaFeaturesOverrideCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SetMediaFeaturesOverrideCommandParameters()

Initializes a new instance of the SetMediaFeaturesOverrideCommandParameters class.

public SetMediaFeaturesOverrideCommandParameters()

Properties

Contexts

Gets the browsing contexts for which to set the emulated media features.

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

Features

Gets or sets the media features to emulate. When null, clears all emulated media features.

[JsonPropertyName("features")]
public MediaFeatures? Features { get; set; }

Property Value

MediaFeatures

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

ResetMediaFeaturesOverride

Gets a pre-initialized instance of SetMediaFeaturesOverrideCommandParameters with the Features property set to null to clear any existing media features 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 SetMediaFeaturesOverrideCommandParameters ResetMediaFeaturesOverride { get; }

Property Value

SetMediaFeaturesOverrideCommandParameters

UserContexts

Gets the user contexts for which to set the emulated media features.

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