Class ProgressMessage

Namespace

GroupeIsa.Neos.Application.MethodRunners

Assembly

GroupeIsa.Neos.Application.Abstractions.dll

Represents a message about the progress of a background server method.

public sealed class ProgressMessage

Inheritance

object

ProgressMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ProgressMessage()

Initializes a new instance of the ProgressMessage class.

public ProgressMessage()

Properties

AdditionalData

Gets or sets additional data.

public Dictionary<string, string> AdditionalData { get; set; }

Property Value

Dictionary<string, string>

ClusterName

Gets or sets the cluster name.

public string ClusterName { get; set; }

Property Value

string

ExecutionIdentifier

Gets or sets the identifier of the server method background execution.

public string ExecutionIdentifier { get; set; }

Property Value

string

Id

Gets the identifier of the message.

public Guid Id { get; }

Property Value

Guid

Message

Gets or sets the message.

public string? Message { get; set; }

Property Value

string

PercentProgress

Gets or sets the percent progress.

public int? PercentProgress { get; set; }

Property Value

int?

ServerMethodName

Gets or sets the server method name.

public string ServerMethodName { get; set; }

Property Value

string

State

Gets or sets the execution state.

public ExecutionState State { get; set; }

Property Value

ExecutionState

Time

Gets or sets the UTC time of the message.

public DateTime Time { get; set; }

Property Value

DateTime

Methods

IsCompleted()

Gets a value indicating whether the execution is completed.

public bool IsCompleted()

Returns

bool

A boolean value indicating whether the execution is completed.

WithClusterName(string)

Sets the cluster name.

public ProgressMessage WithClusterName(string clusterName)

Parameters

clusterName string

Cluster name.

Returns

ProgressMessage

The same instance.