Click or drag to resize

ITaskMonitor Interface
Represents the collection of information that indicates the status of a Publishing Task. Manipulation of the objects that implement this interface is usually done by the task itself.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
Copy
public interface ITaskMonitor

The ITaskMonitor type exposes the following members.

Properties
  NameDescription
Public propertyCompleted
Gets whether the corresponding Publishing Task was completed already.
Public propertyCount
Gets the count of publishing Steps.
Public propertyError
Gets the error message that caused the corresponding Publishing Task to stop.
Public propertyInactive
Gets whether the corresponding Publishing Task was marked as inactive.
Public propertyOngoingStatus
Retrieves the status of publishing task as string message. This message is the description of the ongoing Step or substep in a List Step.
Public propertyOngoingStep
Gets the Step that is currently being executed.
Public propertyPercentCompleted
Gets the completion percentage of the corresponding Publishing Task.
Public propertyTotalWeight
Gets the total weight of all publishing Steps.
Top
Methods
  NameDescription
Public methodAdd
Adds a new Step to monitor to this task.
Public methodAdvanceStep
Marks the previous Ongoing Step to the COMPLETED state.
Public methodClear
Clears the Steps collection.
Public methodRemove
Removes a Step to monitor from this task.
Public methodReset
Marks the monitor as inactive.
Public methodShutdown
Shuts down the monitor and issues the PublishCompleteevent. This method is called by Publishing Task upon completing the task.
Public methodStep(Int32)
Retrieves a Step by its index.
Public methodStep(String)
Retrieves a Step by its unique ID.
Public methodSteps
Retrieves the collection of Steps for the task to be monitored.
Top
See Also