Class SetClientWindowStateCommandResult

Namespace

WebDriverBiDi.Browser

Assembly

WebDriverBiDi.dll

Result for setting the client window state using the browser.setClientWindowState command.

public record SetClientWindowStateCommandResult : CommandResult, IEquatable<CommandResult>, IEquatable<SetClientWindowStateCommandResult>

Inheritance

object

CommandResult

SetClientWindowStateCommandResult

Implements

IEquatable<CommandResult>

IEquatable<SetClientWindowStateCommandResult>

Inherited Members

CommandResult.IsError

CommandResult.AdditionalData

CommandResult.AdditionalResponseProperties

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

This result class is essentially a copy of ClientWindowInfo, as that is the type specified by the protocol. This is structured this way as commands must return a type descending from CommandResult, and C# does not permit multiple inheritance. Should the structure of the info object change, this class will require updates to match.

Constructors

SetClientWindowStateCommandResult(SetClientWindowStateCommandResult)

protected SetClientWindowStateCommandResult(SetClientWindowStateCommandResult original)

Parameters

original SetClientWindowStateCommandResult

Properties

ClientWindowId

Gets the ID of the client window.

[JsonPropertyName("clientWindow")]
[JsonInclude]
[JsonRequired]
public string ClientWindowId { get; }

Property Value

string

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

Height

Gets the value in CSS pixels of the height of the client window.

[JsonPropertyName("height")]
[JsonInclude]
[JsonRequired]
public ulong Height { get; }

Property Value

ulong

IsActive

Gets a value indicating whether a client window is active, usually implying it has focus in the operating system.

[JsonPropertyName("active")]
[JsonInclude]
[JsonRequired]
public bool IsActive { get; }

Property Value

bool

State

Gets a value indicating the state of the client window.

[JsonPropertyName("state")]
[JsonInclude]
[JsonRequired]
public ClientWindowState State { get; }

Property Value

ClientWindowState

Width

Gets the value in CSS pixels of the width of the client window.

[JsonPropertyName("width")]
[JsonInclude]
[JsonRequired]
public ulong Width { get; }

Property Value

ulong

X

Gets the value in CSS pixels of the left edge of the client window.

[JsonPropertyName("x")]
[JsonInclude]
[JsonRequired]
public long X { get; }

Property Value

long

Y

Gets the value in CSS pixels of the top edge of the client window.

[JsonPropertyName("y")]
[JsonInclude]
[JsonRequired]
public long Y { get; }

Property Value

long

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(SetClientWindowStateCommandResult?)

public virtual bool Equals(SetClientWindowStateCommandResult? other)

Parameters

other SetClientWindowStateCommandResult

Returns

bool

Equals(CommandResult?)

public override sealed bool Equals(CommandResult? other)

Parameters

other CommandResult

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(SetClientWindowStateCommandResult?, SetClientWindowStateCommandResult?)

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

Parameters

left SetClientWindowStateCommandResult

right SetClientWindowStateCommandResult

Returns

bool

operator !=(SetClientWindowStateCommandResult?, SetClientWindowStateCommandResult?)

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

Parameters

left SetClientWindowStateCommandResult

right SetClientWindowStateCommandResult

Returns

bool