Class WorkProgressState

Namespace

RDCore.SDK.Client.Progress

Assembly

RDCore.SDK.dll

Where a piece of work the server reports the progress of stands (LSP 3.17 §Work Done Progress): what it is, what it is doing now, and how much of it is done.

public sealed record WorkProgressState : IEquatable<WorkProgressState>

Inheritance

object

WorkProgressState

Implements

IEquatable<WorkProgressState>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WorkProgressState(ProgressToken, string, string?, int?, bool, WorkProgressOrigin)

Where a piece of work the server reports the progress of stands (LSP 3.17 §Work Done Progress): what it is, what it is doing now, and how much of it is done.

public WorkProgressState(ProgressToken Token, string Title, string? Message, int? Percentage, bool IsDone = false, WorkProgressOrigin Origin = WorkProgressOrigin.Request)

Parameters

Token ProgressToken

The token its progress is reported to.

Title string

What the work is.

Message string

What it is doing now; null when it has not said.

Percentage int?

How much of it is done, from 0 to 100; null when that is not known.

IsDone bool

Whether it is done: it ended, or the server that did it went away.

Origin WorkProgressOrigin

Whose work it is: done for a request of the client's, or begun by the server of its own.

Properties

IsDone

Whether it is done: it ended, or the server that did it went away.

public bool IsDone { get; init; }

Property Value

bool

Message

What it is doing now; null when it has not said.

public string? Message { get; init; }

Property Value

string

Origin

Whose work it is: done for a request of the client's, or begun by the server of its own.

public WorkProgressOrigin Origin { get; init; }

Property Value

WorkProgressOrigin

Percentage

How much of it is done, from 0 to 100; null when that is not known.

public int? Percentage { get; init; }

Property Value

int?

Title

What the work is.

public string Title { get; init; }

Property Value

string

Token

The token its progress is reported to.

public ProgressToken Token { get; init; }

Property Value

ProgressToken