Interface IProgressReporter
An interface for reporting the progress of task to the user in the client application, or to logs for server running tasks
Namespace: LemonEdge.Entities.Processors
Assembly: API.dll
Syntax
public interface IProgressReporterMethods
FlushAllPendingMessages()
Writes all pending messages in the progress reporter
Declaration
Task FlushAllPendingMessages()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A task that indicates when the operation is complete |
ReportError(Exception)
Reports an error encountered at the current percentage progress
Declaration
void ReportError(Exception ex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Exception | ex | The exception encountered during the operation |
ReportMessage(String)
Reports a message for the current progress
Declaration
void ReportMessage(string message)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | message | The message to display |
ReportProgress(Decimal, String)
Reports the percentage progress on the current overall operation with a specific message
Declaration
void ReportProgress(decimal progressPercent, string message = "")Parameters
| Type | Name | Description |
|---|---|---|
| System.Decimal | progressPercent | The current progress of the overall operation |
| System.String | message | The message for the current progress |
ReportProgressHeader(String)
Reports the overall header for the current progress state
Declaration
void ReportProgressHeader(string msg)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | msg | The header for the current state of progress |
ReportSubProgress(Int16, Decimal, String)
Reports the percentage progress for the current sub task of the overall operation with a specific message
Declaration
void ReportSubProgress(short subProgressIndex, decimal progressPercent, string message = "")Parameters
| Type | Name | Description |
|---|---|---|
| System.Int16 | subProgressIndex | The index of the current sub task. Sub tasks should start at 1 and increment for each sub task. |
| System.Decimal | progressPercent | The progress of the current sub task |
| System.String | message | The message for the current progress of the sub task |