Class TaskInformation

NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version. Contains information such as status and result (if the asynchronus job returned a result) associated with a task.

Inheritance

System.Object

TaskInformation

TaskInformation<T>

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Async

Assembly: EPiServer.Framework.dll

Version: 8.11.0

Syntax

public class TaskInformation

Constructors

TaskInformation()

Default constructor

Declaration

public TaskInformation()

TaskInformation(Guid)

Constructor to create status with specific id.

Declaration

public TaskInformation(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Properties

Completed

Time (in UTC) for when the task was completed.

Declaration

public DateTime Completed { get; set; }

Property Value

Type	Description
System.DateTime

CompletedStatus

Contains the status of the task when it was completed. Before completion value is System.Threading.Tasks.TaskStatus.Created

Declaration

public TaskStatus CompletedStatus { get; set; }

Property Value

Type	Description
System.Threading.Tasks.TaskStatus

Created

Time (in UTC) for when the task was created.

Declaration

public DateTime Created { get; set; }

Property Value

Type	Description
System.DateTime

Exception

In case a task is faulting, this contains the exception message.

Declaration

public string Exception { get; set; }

Property Value

Type	Description
System.String

Id

The unique identifier associated with the task.

Declaration

public Guid Id { get; set; }

Property Value

Type	Description
System.Guid

IsTrackable

Indicates if the task was created with an associated TrackingToken

Declaration

public bool IsTrackable { get; set; }

Property Value

Type	Description
System.Boolean

Result

In case the asyncronus task had a return value this is the outcome of the task.

Declaration

public object Result { get; set; }

Property Value

Type	Description
System.Object

ResultType

Gets or sets the System.Type for Result. This is used to be able to query for result of specific type.

Declaration

public string ResultType { get; set; }

Property Value

Type	Description
System.String

User

The user under which the context the task was created.

Declaration

public string User { get; set; }

Property Value

Type	Description
System.String