Class ServerTaskStatus

Inheritance
object
BaseEntity
ServerTaskStatus
Implements
Inherited Members
Namespace: LemonEdge.API.Entities.Tasks
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class ServerTaskStatus : BaseEntity, IServerTaskStatus, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ITaskMessage, ICloneableAsync<IServerTaskStatus>

Constructors

ServerTaskStatus()

Declaration
public ServerTaskStatus()

Properties

Message

The message from the task for this status

Declaration
public string Message { get; set; }
Property Value
Type Description
string

Progress

The current progress of the task when these message is recorded

Declaration
public decimal Progress { get; set; }
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
public short ProgressIndex { get; set; }
Property Value
Type Description
short

ServerTaskID

[Key] Links to IServerTask. The parent server task this progress status belongs to

Declaration
[Required]
[RequiredNoDefaultIDValidation]
public Guid ServerTaskID { get; set; }
Property Value
Type Description
Guid

ServerTaskID_Label

Declaration
public string ServerTaskID_Label { get; set; }
Property Value
Type Description
string

ServerTaskID_Label_Silent

Declaration
[NotMapped]
public string ServerTaskID_Label_Silent { get; set; }
Property Value
Type Description
string

Type

Indicates the type of message for this server task status.

Declaration
[EnumDataType(typeof(TaskMessageType))]
public TaskMessageType Type { get; set; }
Property Value
Type Description
TaskMessageType

Type_Tooltip

Declaration
[NotMapped]
public string Type_Tooltip { get; set; }
Property Value
Type Description
string

Methods

CopyFromEntity(IBaseEntity)

Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Type Name Description
IBaseEntity src
Overrides

CopyFromSource(IServerTaskStatus)

Updates all properties in this item to have the same properties as the source object.

Declaration
public void CopyFromSource(IServerTaskStatus source)
Parameters
Type Name Description
IServerTaskStatus source

The source object to copy all values from.

Implements

Extension Methods