Class GetDataCommandParameters

Namespace

WebDriverBiDi.Network

Assembly

WebDriverBiDi.dll

Provides parameters for the network.getData command.

public class GetDataCommandParameters : CommandParameters<GetDataCommandResult>

Inheritance

object

CommandParameters

CommandParameters<GetDataCommandResult>

GetDataCommandParameters

Inherited Members

CommandParameters<GetDataCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

GetDataCommandParameters(string, DataType)

Initializes a new instance of the GetDataCommandParameters class.

public GetDataCommandParameters(string requestId, DataType dataType)

Parameters

requestId string

The ID of the network request for which to fetch network data from the collector.

dataType DataType

The DataType of the collected network data to get.

Properties

CollectorId

Gets or sets the ID of the data collector for which to get collected network data.

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

Property Value

string

DataType

Gets or sets the DataType of collected network data to get.

[JsonPropertyName("dataType")]
public DataType DataType { get; set; }

Property Value

DataType

DisownCollectedData

Gets or sets a value indicating whether the retrieved collected data should be removed from the collector after retrieval.

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

Property Value

bool?

Remarks

Setting this to true requires CollectorId to name the collector the data is removed from; a command that disowns without naming one is rejected by the remote end with an invalid argument error.

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

RequestId

Gets or sets the ID of the request for which to get collected network data.

[JsonPropertyName("request")]
public string RequestId { get; set; }

Property Value

string