Class SetBypassCSPCommandParameters

Namespace

WebDriverBiDi.BrowsingContext

Assembly

WebDriverBiDi.dll

Provides parameters for the browsingContext.setBypassCSP command.

public class SetBypassCSPCommandParameters : CommandParameters<SetBypassCSPCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetBypassCSPCommandResult>

SetBypassCSPCommandParameters

Inherited Members

CommandParameters<SetBypassCSPCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SetBypassCSPCommandParameters()

Initializes a new instance of the SetBypassCSPCommandParameters class.

public SetBypassCSPCommandParameters()

Properties

Bypass

Gets or sets a value indicating whether to bypass content security policies (CSP) for the specified contexts. Note that null and false are functionally equivalent.

[JsonIgnore]
public bool? Bypass { get; set; }

Property Value

bool?

Contexts

Gets the browsing contexts for which to bypass content security policies (CSP).

[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

ResetBypassCSP

Gets a pre-initialized instance of SetBypassCSPCommandParameters with the Bypass property set to null to clear any existing bypass CSP 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 SetBypassCSPCommandParameters ResetBypassCSP { get; }

Property Value

SetBypassCSPCommandParameters

UserContexts

Gets the user contexts for which to bypass content security policies (CSP).

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