ITaskProcessingJobTDirective Interface |
Namespace: MFiles.VAF.AppTasks
The ITaskProcessingJobTDirective type exposes the following members.
Name | Description | |
---|---|---|
![]() | AbortJobToken |
Token that signals if the job has been asked to abort.
|
![]() | CancellationMessage |
Message given for task cancellation, if it has been requested.
Typically should be included in final status of the task if it marked canceled.
|
![]() | CancelTaskToken |
Token that signals if task cancellation has been requested.
|
![]() | Directive |
The task directive.
|
![]() | IsJobAbortRequested |
Indicates whether the job has been asked to abort.
|
![]() | IsTaskCancellationRequested |
Indicates whether it has been requested that the job's task is cancelled.
|
![]() | Retries |
The number of times this job has been retried.
|
![]() | TaskInfo |
The application task info.
|
![]() | ThrowOnUpdateBehavior |
Indicates when a call to Update(NullableInt32, String, JObject) should throw.
|
![]() | TransactionMode |
The transaction mode.
|
![]() | Vault |
Vault access.
Transaction scope is determined by the TransactionMode.
|
Name | Description | |
---|---|---|
![]() | Commit |
Used to finalize task processing in Hybrid mode.
The callback runs in the scope of a vault transaction along with the final task
completed state. If any part of the callback or task completion steps fail,
all vault operations performed in the callback will be rolled back.
Throws if called more than once.
Throws if not in Hybrid mode.
|
![]() | GetStatus |
Gets a snapshot of the current job status.
Use Update(NullableInt32, String, JObject) to modify.
|
![]() | ThrowIfJobAbortRequested |
Throws if the job has been asked to abort.
|
![]() | ThrowIfTaskCancellationRequested |
Throws if it has been requested that the job's task is cancelled.
|
![]() | Transaction |
Runs a callback in the scope of a vault transaction.
If the method fails, all operations made with the provided vault will be rolled back.
If the method succeeds, all operations made with the provided vault will be committed.
|
![]() | Update |
Updates the in-progress status of the task.
|
Name | Description | |
---|---|---|
![]() | Completed |
Triggered when the job either succeeds or fails.
|
![]() | Failed |
Triggered when the job fails.
|
![]() | SaveTriggered |
Triggered when the job was asked to commit it's progress/status to the vault.
This can't always be done, even when triggered, due to risks of transaction
lock conflicts, but this can be used to store progress data elsewhere in those
cases.
|
![]() | Succeeded |
Triggered when the job finishes successfully.
|