Class ClientHintsMetadata

Namespace

WebDriverBiDi.UserAgentClientHints

Assembly

WebDriverBiDi.dll

Provides parameters for the overriding client hints for the browser.

public class ClientHintsMetadata

Inheritance

object

ClientHintsMetadata

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ClientHintsMetadata()

public ClientHintsMetadata()

Properties

Architecture

Gets or sets the architecture for overriding client hints.

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

Property Value

string

Bitness

Gets or sets the bit-ness for overriding client hints.

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

Property Value

string

Brands

Gets or sets the list of brands for overriding client hints.

[JsonPropertyName("brands")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public List<BrandVersion>? Brands { get; set; }

Property Value

List<BrandVersion>

Remarks

This list is deliberately nullable and settable, because the emulation branches on whether the member is present rather than on what it contains: an absent member leaves the brands the browser reports for itself in place, while a member present as an empty list overrides them with no brands at all. Leave this property null to keep the browser's own value; set it to an empty list to override it with none.

FormFactors

Gets or sets the list of form factors for overriding client hints.

[JsonPropertyName("formFactors")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public List<string>? FormFactors { get; set; }

Property Value

List<string>

Remarks

This list is nullable and settable for parity with Brands and FullVersionList, which the protocol defines alike. Unlike those two, form factors are not yet part of the emulated client hints the specification defines, so the specification gives this member no effect, whether it is absent or present. Leave this property null to omit it; set it to a list, which may be empty, to send it.

FullVersionList

Gets or sets the list of full versions for overriding client hints.

[JsonPropertyName("fullVersionList")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public List<BrandVersion>? FullVersionList { get; set; }

Property Value

List<BrandVersion>

Remarks

This list is deliberately nullable and settable, because the emulation branches on whether the member is present rather than on what it contains: an absent member leaves the full version list the browser reports for itself in place, while a member present as an empty list overrides it with no entries at all. Leave this property null to keep the browser's own value; set it to an empty list to override it with none.

Mobile

Gets or sets a value indicating whether the overridden client hints indicate a mobile user agent.

[JsonPropertyName("mobile")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? Mobile { get; set; }

Property Value

bool?

Model

Gets or sets the model for overriding client hints.

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

Property Value

string

Platform

Gets or sets the platform for overriding client hints.

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

Property Value

string

PlatformVersion

Gets or sets the platform version for overriding client hints.

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

Property Value

string

Wow64

Gets or sets a value indicating whether the overridden client hints indicate a WOW64 user agent.

[JsonPropertyName("wow64")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? Wow64 { get; set; }

Property Value

bool?