Click or drag to resize

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. Its property values cannot be changed.

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

The IStep type exposes the following members.

Properties
  NameDescription
Public propertyDescription
Gets the description of the step.
Public propertyError
Gets the error message of the step.
Public propertyID
Gets the identifier of the step.
Public propertyName
Gets the name of the step.
Public propertyState
Gets the state of the step.
Top
Methods
  NameDescription
Public methodBegin
Changes the step's state to ON_GOING.
Public methodComplete
Changes the step's state to COMPLETED.
Public methodCompleteWithError
Changes the step's state to COMPLETED, but includes an error message; this is not a successful completion.
Top
See Also