Class CollectionRemoteValue

Namespace

WebDriverBiDi.Script

Assembly

WebDriverBiDi.dll

Represents a remote value for a list-like object, providing type-safe access to the value and the ability to convert to a local value for use as an argument for script execution on the remote end.

public record CollectionRemoteValue : RemoteValue, IEquatable<RemoteValue>, IObjectReferenceRemoteValue, ITypeSafeRemoteValue<RemoteValueList?>, IEquatable<CollectionRemoteValue>

Inheritance

object

RemoteValue

CollectionRemoteValue

Implements

IEquatable<RemoteValue>

IObjectReferenceRemoteValue

ITypeSafeRemoteValue<RemoteValueList>

IEquatable<CollectionRemoteValue>

Inherited Members

RemoteValue.As<T>()

RemoteValue.TryAs<T>(out T)

RemoteValue.Type

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

CollectionRemoteValue(CollectionRemoteValue)

protected CollectionRemoteValue(CollectionRemoteValue original)

Parameters

original CollectionRemoteValue

Properties

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

Handle

Gets the handle of this RemoteValue.

[JsonPropertyName("handle")]
[JsonInclude]
public string? Handle { get; }

Property Value

string

InternalId

Gets the internal ID of this RemoteValue.

[JsonPropertyName("internalId")]
[JsonInclude]
public string? InternalId { get; }

Property Value

string

Value

Gets the RemoteValueList containing the values of this remote value.

[JsonPropertyName("value")]
[JsonInclude]
[JsonConverter(typeof(RemoteValueListJsonConverter))]
public RemoteValueList? Value { get; }

Property Value

RemoteValueList

Remarks

This value may be null if the remote value was deserialized without a value property.

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(CollectionRemoteValue?)

public virtual bool Equals(CollectionRemoteValue? other)

Parameters

other CollectionRemoteValue

Returns

bool

Equals(RemoteValue?)

public override sealed bool Equals(RemoteValue? other)

Parameters

other RemoteValue

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToLocalValue()

Converts this remote value to a local value for use as an argument for script execution on the remote end.

public override LocalValue ToLocalValue()

Returns

LocalValue

A LocalValue representing the list-like value.

Exceptions

WebDriverBiDiException

Thrown when the Value property is null.

ToRemoteObjectReference()

Converts this RemoteValue into a RemoteObjectReference.

public RemoteObjectReference ToRemoteObjectReference()

Returns

RemoteObjectReference

The RemoteObjectReference object representing this RemoteValue.

Exceptions

WebDriverBiDiException

Thrown when the RemoteValue does not have a handle set.

ToString()

public override string ToString()

Returns

string

Operators

operator ==(CollectionRemoteValue?, CollectionRemoteValue?)

public static bool operator ==(CollectionRemoteValue? left, CollectionRemoteValue? right)

Parameters

left CollectionRemoteValue

right CollectionRemoteValue

Returns

bool

operator !=(CollectionRemoteValue?, CollectionRemoteValue?)

public static bool operator !=(CollectionRemoteValue? left, CollectionRemoteValue? right)

Parameters

left CollectionRemoteValue

right CollectionRemoteValue

Returns

bool