Interface ITaskMessage

The base interface for items reporting messages of a task status. Implemented by IServerTaskStatus

See https://web.lemonedge.com/help/server-task-statuses-view/ for more information

Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
public interface ITaskMessage

Properties

LastUpdated

Declaration
DateTimeOffset LastUpdated { get; }
Property Value
Type Description
System.DateTimeOffset

Message

The message from the task for this status

Declaration
string Message { get; }
Property Value
Type Description
System.String

Progress

The current progress of the task when these message is recorded

Declaration
decimal Progress { get; }
Property Value
Type Description
System.Decimal

ProgressIndex

All main progress task statuses have a default index of 0. However Tasks can process multiple stages each with their own progress. The individual progress of those sub-stages is held with an incremented index for each stage.

For instance when an IImportDefinition processes a stage, the progress of that stage being processed is held with a Progress Index of 1. The main progress of each step increments along using the default index of 0.

Declaration
short ProgressIndex { get; }
Property Value
Type Description
System.Int16

Type

Indicates the type of message for this server task status.

Declaration
TaskMessageType Type { get; }
Property Value
Type Description
TaskMessageType

Extension Methods