RhinoAccoountsProgressInfo

References
This class is designed to convey the progress of an asynchronous operation through .NET's IProgress<T> interface. It can be used by callers of such tasks to relay the tasks' progress, as well as useful metadata information that may be of interest.

Constructors

RhinoAccoountsProgressInfo

#
public RhinoAccoountsProgressInfo(ProgressState state, Dictionary<object, object> metadata = null, string customDescription = null)
Creates a new instance.
state (ProgressState)The state to report.
metadata (Dictionary<object, object> = null)Optional. Any metadata of interest that may be used by the caller of a task.
customDescription (string = null)Optional. If a non-null value is passed, it will override the default description of the instance.

Properties

Description

#Since v7.0
public string Description { get; }
A localized description of the state that may be shown to the user of the application.

Metadata

#Since v7.0
public Dictionary<object, object> Metadata { get; }
Any metadata of interest that may be used by the caller of a task.

State

#Since v7.0
public ProgressState State { get; }
The state to report.