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.API.Core.Reporting
Assembly: LemonEdge.API.dll
Syntax
public interface IProgressReporter

Methods

FlushAllPendingMessages()

Writes all pending messages in the progress reporter

Declaration
Task FlushAllPendingMessages()
Returns
Type Description
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
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
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
decimal progressPercent

The current progress of the overall operation
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
string msg

The header for the current state of progress

ReportProgressWithForceSave(decimal, string)

Reports the percentage progress on the current overall operation with a specific message

Declaration
void ReportProgressWithForceSave(decimal progressPercent, string message = "")
Parameters
Type Name Description
decimal progressPercent

The current progress of the overall operation
string message

The message for the current progress

ReportSubProgress(short, 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
short subProgressIndex

The index of the current sub task. Sub tasks should start at 1 and increment for each sub task.
decimal progressPercent

The progress of the current sub task
string message

The message for the current progress of the sub task

Extension Methods