Interface IServerTaskStatus
The system entity for a server task, which can be offloaded and run on the task services rather than locally
See https://web.lemonedge.com/help/server-tasks/ for more information
Inherited Members
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.ServerTaskStatus, "dbo.LT_ServerTaskStatuses", "ServerTaskStatus", SelectWithNoLock = true)]
[DefaultEntityIcon(ImageType.History)]
public interface IServerTaskStatus : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ITaskMessage
Properties
Message
The message from the task for this status
Declaration
[EntityProperty(SQLType.NVarChar, false)]
[EntityDescription("Current server task status message.")]
string Message { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Progress
The current progress of the task when these message is recorded
Declaration
[EntityProperty(SQLType.Decimal, (short)18, (short)12, false)]
[EntityDescription("The current progress index this progress percent is for (0 is overall progress).")]
decimal Progress { get; set; }
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
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The current progress index this progress percent is for (0 is overall progress).")]
short ProgressIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int16 |
ServerTaskID
[Key] Links to IServerTask. The parent server task this progress status belongs to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.ServerTask, "ID", SingleJoinType.One, "Server Task", "Statuses", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = true)]
[Required]
Guid ServerTaskID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Type
Indicates the type of message for this server task status.
Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("Indicates the type of message for this server task status.")]
TaskMessageType Type { get; set; }
Property Value
Type | Description |
---|---|
TaskMessageType |