Class LocateNodesCommandParameters

Namespace

WebDriverBiDi.BrowsingContext

Assembly

WebDriverBiDi.dll

Provides parameters for the browsingContext.locateNodes command.

public class LocateNodesCommandParameters : CommandParameters<LocateNodesCommandResult>

Inheritance

object

CommandParameters

CommandParameters<LocateNodesCommandResult>

LocateNodesCommandParameters

Inherited Members

CommandParameters<LocateNodesCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LocateNodesCommandParameters(string, Locator)

Initializes a new instance of the LocateNodesCommandParameters class.

public LocateNodesCommandParameters(string browsingContextId, Locator locator)

Parameters

browsingContextId string

The ID of the browsing context in which to locate nodes.

locator Locator

The locator used to locate nodes.

Properties

BrowsingContextId

Gets or sets the ID of the browsing context in which to locate nodes.

[JsonPropertyName("context")]
public string BrowsingContextId { get; set; }

Property Value

string

Locator

Gets or sets the locator used to locate nodes.

[JsonPropertyName("locator")]
public Locator Locator { get; set; }

Property Value

Locator

MaxNodeCount

Gets or sets the maximum number of nodes to be returned by the command. When omitted or null, the command returns all located nodes.

[JsonPropertyName("maxNodeCount")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[SpecRange(1, Infinity)]
public ulong? MaxNodeCount { get; set; }

Property Value

ulong?

Remarks

Valid values for this property are greater than or equal to 1. This property does not validate its value; a value outside this range is sent as-is, and a conforming remote end rejects it when the command is executed.

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

SerializationOptions

Gets or sets the serialization options for serializing located node references.

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

Property Value

SerializationOptions

StartNodes

Gets the list of nodes within which to locate child nodes. If empty, nodes are located from the active document of the browsing context identified by BrowsingContextId.

[JsonIgnore]
public List<SharedReference> StartNodes { get; }

Property Value

List<SharedReference>