Interface ITaskMessage
The base interface for items reporting messages of a task status. Implemented by IServerTaskStatus
See https://help.lemonedge.com/help/open-architecture/status/server-tasks/statuses-view.html for more information
Namespace: LemonEdge.API.Core.Tasks
Assembly: LemonEdge.API.dll
Syntax
public interface ITaskMessage
Properties
LastUpdated
Declaration
DateTimeOffset LastUpdated { get; }
Property Value
Type | Description |
---|---|
DateTimeOffset |
Message
The message from the task for this status
Declaration
string Message { get; }
Property Value
Type | Description |
---|---|
string |
Progress
The current progress of the task when these message is recorded
Declaration
decimal Progress { get; }
Property Value
Type | Description |
---|---|
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 |
---|---|
short |
Type
Indicates the type of message for this server task status.
Declaration
TaskMessageType Type { get; }
Property Value
Type | Description |
---|---|
TaskMessageType |