Class TaskMonitor
Component that monitors task that are trackable (that is associated with a TrackingToken).
Inheritance
Inherited Members
Namespace: EPiServer.Async
Assembly: EPiServer.Framework.dll
Version: 11.20.7Syntax
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.