Class ManualProxyConfiguration

Namespace

WebDriverBiDi.Session

Assembly

WebDriverBiDi.dll

Object representing a manual proxy to be used by the browser.

public class ManualProxyConfiguration : ProxyConfiguration

Inheritance

object

ProxyConfiguration

ManualProxyConfiguration

Inherited Members

ProxyConfiguration.ProxyType

ProxyConfiguration.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ManualProxyConfiguration()

Initializes a new instance of the ManualProxyConfiguration class.

[JsonConstructor]
public ManualProxyConfiguration()

Properties

HttpProxy

Gets or sets the address to be used to proxy HTTP commands.

[JsonPropertyName("httpProxy")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? HttpProxy { get; set; }

Property Value

string

NoProxyAddresses

Gets a list of addresses to be bypassed by the proxy.

[JsonIgnore]
public List<string> NoProxyAddresses { get; }

Property Value

List<string>

Remarks

This property is optional in the protocol, and omitting it has the same meaning as sending an empty array: the bypass list is the addresses this member names, and naming none is the same as naming nothing. An empty list therefore means "not specified": the property is omitted from the JSON payload entirely. Add entries to the list to populate it. When this configuration is read back from a session's capabilities, a payload that omits the member and one that sends an empty array both produce an empty list.

SocksProxy

Gets or sets the address of a SOCKS proxy used to proxy commands.

[JsonPropertyName("socksProxy")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? SocksProxy { get; set; }

Property Value

string

Remarks

The specification groups this member with SocksVersion: whenever one is present, the other must be present as well. The pairing is not validated here; a conforming remote end rejects a configuration providing only one of the two.

SocksVersion

Gets or sets the version of the SOCKS proxy to be used.

[JsonPropertyName("socksVersion")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[SpecRange(0, 255)]
public ulong? SocksVersion { get; set; }

Property Value

ulong?

Remarks

Valid values for this property range from 0 to 255, inclusive. The specification groups this member with SocksProxy: whenever one is present, the other must be present as well. Neither the range nor the pairing is validated here; a value outside the range, or a configuration providing only one of the two members, is sent as-is, and a conforming remote end rejects it when the command is executed.

SslProxy

Gets or sets the address to be used to proxy HTTPS commands.

[JsonPropertyName("sslProxy")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? SslProxy { get; set; }

Property Value

string