Class SetScreenSettingsOverrideCommandParameters

Namespace

WebDriverBiDi.Emulation

Assembly

WebDriverBiDi.dll

Provides parameters for the emulation.setScreenSettingsOverride command.

public class SetScreenSettingsOverrideCommandParameters : CommandParameters<SetScreenSettingsOverrideCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetScreenSettingsOverrideCommandResult>

SetScreenSettingsOverrideCommandParameters

Inherited Members

CommandParameters<SetScreenSettingsOverrideCommandResult>.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

SetScreenSettingsOverrideCommandParameters()

Initializes a new instance of the SetScreenSettingsOverrideCommandParameters class.

public SetScreenSettingsOverrideCommandParameters()

Properties

Contexts

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

ResetScreenSettingsOverride

Gets a pre-initialized instance of SetScreenSettingsOverrideCommandParameters with the ScreenArea property set to null to clear any existing screen settings 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 SetScreenSettingsOverrideCommandParameters ResetScreenSettingsOverride { get; }

Property Value

SetScreenSettingsOverrideCommandParameters

ScreenArea

Gets or sets the area of the screen to emulate. When null, clears the override.

[JsonPropertyName("screenArea")]
public ScreenArea? ScreenArea { get; set; }

Property Value

ScreenArea

UserContexts

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