IStep Interface |
Represents the information of a step/task entry in a background task to be monitored. Steps are the building blocks of the Task Monitor, which is used to monitor the progress of a task.
Steps are normally constructed with full information during construction of a Task Monitor. Their property values cannot be changed.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxThe IStep type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | Description | Gets the description of the step. |
| Error | Gets the error message of the step. |
| ID | Gets the identifier of the step. |
| Name | Gets the name of the step. |
| State | Gets the state of the step. |
Methods| Name | Description | |
|---|---|---|
 | Begin | Changes the step's state to ON_GOING. |
| Complete | Changes the step's state to COMPLETED. |
| CompleteWithError | Changes the step's state to COMPLETED, but includes an error message; this is not a successful completion. |
See AlsoReference
IContentItemPostProcessStep