Click or drag to resize

IContentItemPublishStep Interface


Represents a step in the Publishing Tasks Monitor.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax
public interface IContentItemPublishStep : IStepWithWeight, 
	IStep

The IContentItemPublishStep type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleDescription
Gets the description of the step.
(Inherited from IStep.)
Public propertyError
Gets the error message of the step.
(Inherited from IStep.)
Public propertyID
Gets the identifier of the step.
(Inherited from IStep.)
Public propertyName
Gets the name of the step.
(Inherited from IStep.)
Public propertyPercentCompleted
Gets the percentage of completion of the publishing step.
Public propertyPublishedCount
Gets the count of pages that were published.
Public propertyState
Gets the state of the step.
(Inherited from IStep.)
Public propertyTotalCount
Gets the total count of pages to be published.
Public propertyWeight
Gets the weight of this step.
(Inherited from IStepWithWeight.)
Top
Methods
  NameDescription
Public methodBegin
Changes the step's state to ON_GOING.
(Inherited from IStep.)
Public methodComplete
Changes the step's state to COMPLETED.
(Inherited from IStep.)
Public methodCompleteWithError
Changes the step's state to COMPLETED, but includes an error message; this is not a successful completion.
(Inherited from IStep.)
Public methodUpdatePublishedCount
Updates the count of published Pages. This method adds the count of just-published pages to the total published pages count.
Top
See Also