Interface IBatchTask
Plug-in interface for tasks.
Namespace: SuperOffice.CRM.BatchProcessing
Assembly: SoBatchProcessing.dll
Syntax
public interface IBatchTaskMethods
EndTaskAsync(CancellationToken)
End the currently executing task.
Declaration
Task EndTaskAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |
GetTaskInfoAsync(CancellationToken)
Get current information about the task.
Declaration
Task<BatchTaskInfo> GetTaskInfoAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<BatchTaskInfo> | Task info object with id, name, owner, state, result values |
RunTaskAsync(BatchTaskInfo, string, BatchTaskStatusChangedAsync, CancellationToken)
Start a new task based on a task descriptiong include name
Declaration
Task RunTaskAsync(BatchTaskInfo batchTaskInfo, string context, BatchTaskStatusChangedAsync onBatchTaskStatusChanged, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| BatchTaskInfo | batchTaskInfo | Id, Name and state of the task. |
| string | context | Context for the task. |
| BatchTaskStatusChangedAsync | onBatchTaskStatusChanged | Callback for status changes of the task. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task | Task info object with id, name, owner, state, result values |