ITask
|
Represents the collection of information that indicates the status of a Publishing Task.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxThe ITaskMonitor type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Completed | Gets whether the corresponding Publishing Task was completed. |
| Count | Gets the count of publishing Steps. |
| Error | Gets the error message that caused the corresponding Publishing Task to stop. |
| Inactive | Gets whether the corresponding Publishing Task was marked as inactive. |
| OngoingStatus | Retrieves the status of publishing task as string message. This message is the description of the ongoing Step or sub-step in a List Step. |
| OngoingStep | Gets the Step that is currently being executed. |
| PercentCompleted | Gets the completion percentage of the corresponding Publishing Task. |
| TotalWeight | Gets the total weight of all publishing Steps. |
Methods| Name | Description | |
|---|---|---|
 | Add | Adds a new Step to monitor to this task. |
| AdvanceStep | Marks the previous Ongoing Step as COMPLETED. |
| Clear | Clears the Steps collection. |
| Remove | Removes a Step to monitor from this task. |
| Reset | Marks the monitor as inactive. |
| Shutdown | Shuts down the monitor and issues the PublishCompleteevent. This method is called by Publishing Task upon completing the task. |
| Step(Int32) | Retrieves a Step by its index. |
| Step(String) | Retrieves a Step by its unique ID. |
| Steps | Retrieves the collection of Steps for the task to be monitored. |
RemarksManipulation of the objects that implement this interface is usually done by the task itself.
See Also