Table of Contents

Class AddDataCollectorCommandParameters

Namespace
WebDriverBiDi.Network
Assembly
WebDriverBiDi.dll

Provides parameters for the network.addDataCollector command.

public class AddDataCollectorCommandParameters : CommandParameters<AddDataCollectorCommandResult>
Inheritance
AddDataCollectorCommandParameters
Inherited Members

Constructors

AddDataCollectorCommandParameters(ulong, DataType, params DataType[])

Initializes a new instance of the AddDataCollectorCommandParameters class.

public AddDataCollectorCommandParameters(ulong maxEncodedDataSize, DataType collectionDataType, params DataType[] additionalCollectionDataTypes)

Parameters

maxEncodedDataSize ulong

The maximum size (in bytes) allocated to be collected for each request or response collected. Note carefully that zero (0) is an invalid value for maximum size.

collectionDataType DataType

The DataType value specifying the type for which data will be collected.

additionalCollectionDataTypes DataType[]

One or more additional DataType values specifying the type for which data will also be collected.

Properties

CollectorType

Gets or sets the type of this data collector. If unset, defaults to Blob.

[JsonPropertyName("collectorType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public CollectorType? CollectorType { get; set; }

Property Value

CollectorType?

Contexts

Gets the list of browsing context IDs for which to collect network data.

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

DataTypes

Gets the set of DataType values associated with this data collector.

[JsonPropertyName("dataTypes")]
public HashSet<DataType> DataTypes { get; }

Property Value

HashSet<DataType>

MaxEncodedDataSize

Gets or sets the maximum encoded data size for this collector in bytes.

[JsonPropertyName("maxEncodedDataSize")]
public ulong MaxEncodedDataSize { get; set; }

Property Value

ulong

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

UserContexts

Gets the list of user context IDs for which to collect network data.

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

Edit this page