Class ObjectReferenceRemoteValue

Namespace

WebDriverBiDi.Script

Assembly

WebDriverBiDi.dll

Represents a remote value for an object reference from the remote end, providing the ability to convert to a local value for use as an argument for script execution on the remote end.

public record ObjectReferenceRemoteValue : RemoteValue, IEquatable<RemoteValue>, IObjectReferenceRemoteValue, IEquatable<ObjectReferenceRemoteValue>

Inheritance

object

RemoteValue

ObjectReferenceRemoteValue

Implements

IEquatable<RemoteValue>

IObjectReferenceRemoteValue

IEquatable<ObjectReferenceRemoteValue>

Derived

WindowProxyRemoteValue

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

ObjectReferenceRemoteValue(ObjectReferenceRemoteValue)

protected ObjectReferenceRemoteValue(ObjectReferenceRemoteValue original)

Parameters

original ObjectReferenceRemoteValue

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

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(ObjectReferenceRemoteValue?)

public virtual bool Equals(ObjectReferenceRemoteValue? other)

Parameters

other ObjectReferenceRemoteValue

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 object reference.

ToRemoteObjectReference()

Converts this RemoteValue into a RemoteObjectReference.

public virtual 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 ==(ObjectReferenceRemoteValue?, ObjectReferenceRemoteValue?)

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

Parameters

left ObjectReferenceRemoteValue

right ObjectReferenceRemoteValue

Returns

bool

operator !=(ObjectReferenceRemoteValue?, ObjectReferenceRemoteValue?)

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

Parameters

left ObjectReferenceRemoteValue

right ObjectReferenceRemoteValue

Returns

bool