Class TaskMonitor

NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version. Component that monitors task that are trackable (that is associated with a TrackingToken).

Inheritance

System.Object

TaskMonitor

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 abstract class TaskMonitor

Constructors

TaskMonitor()

Declaration

protected TaskMonitor()

Methods

GetStatus(TrackingToken)

Retrieves a the specific TaskInformation that is associated with trackingToken.

Declaration

public abstract TaskInformation GetStatus(TrackingToken trackingToken)

Parameters

Type	Name	Description
TrackingToken	trackingToken	The TrackingToken used when creating the task.

Returns

Type	Description
TaskInformation	Information and outcome about the task.

Remarks

The persisting of task information is done asynchronusly meaning there is no guarantee that status has been persisted when task is completed.

GetStatus<TResult>(TrackingToken)

Retrieves a the specific TaskInformation<T> that is associated with trackingToken.

Declaration

public TaskInformation<TResult> GetStatus<TResult>(TrackingToken trackingToken)

    where TResult : new()

Parameters

Type	Name	Description
TrackingToken	trackingToken	The TrackingToken used when creating the task.

Returns

Type	Description
TaskInformation<TResult>	Information and result about the task.

Type Parameters

Name	Description
TResult	The type of result from the task created from TaskExecutor.

Remarks

The persisting of task information is done asynchronusly meaning there is no guarantee that status has been persisted when task is completed.

ListStatuses<TResult>()

Lists information about all tasks with specified result type.

Declaration

public abstract IEnumerable<TaskInformation<TResult>> ListStatuses<TResult>()

    where TResult : new()

Returns

Type	Description
System.Collections.Generic.IEnumerable<TaskInformation<TResult>>	A list of all statuses for given type.

Type Parameters

Name	Description
TResult	The type of result from the task created from TaskExecutor.

QueryStatuses()

A queryable that can be used with Linq to get a filtered list of statuses.

Declaration

public abstract IQueryable<TaskInformation> QueryStatuses()

Returns

Type	Description
System.Linq.IQueryable<TaskInformation>	A Linq Queryable