IPublish
|
Represents the collection of information that indicates the status of a Publishing Target's ongoing Publishing Task.
Has more details than the ITaskMonitor and Content Store storage presence.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxThe IPublishTaskMonitor type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity) |
| AssetPublishingStep | Gets the step that performs a Asset's publish. |
| AssetsCount | Retrieves the count of Assets to be published by the corresponding Publishing Task. |
| BuildAssetUrlMapStep | Gets the step that builds the asset URL Map. |
| BuildUrlMapStep | Gets the step that builds the URL Map. |
| Completed |
Gets whether the corresponding Publishing Task was completed.
(Inherited from ITaskMonitor) |
| Count |
Gets the count of publishing Steps.
(Inherited from ITaskMonitor) |
| Created |
Gets the entity's creation date.
(Inherited from IEntity) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity) |
| DeletePubFolderStep | Gets the step that cleans up the target folder location of the Publishing Target to which the corresponding Publishing Task publishes. |
| Error |
Gets the error message that caused the corresponding Publishing Task to stop.
(Inherited from ITaskMonitor) |
| Inactive |
Gets whether the corresponding Publishing Task was marked as inactive.
(Inherited from ITaskMonitor) |
| IsFullPublish | Gets whether the corresponding Publishing Task executes a full publish. |
| LastModified |
Gets the date when the entity was most recently modified.
(Inherited from IEntity) |
| LastModifiedUser |
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity) |
| Manager |
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager) |
| 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.
(Inherited from ITaskMonitor) |
| OngoingStep |
Gets the Step that is currently being executed.
(Inherited from ITaskMonitor) |
| PagePublishingStep | Gets the step that performs a Page's publish. |
| PagesCount | Retrieves the count of Pages to be published by the corresponding Publishing Task. |
| PercentCompleted |
Gets the completion percentage of the corresponding Publishing Task.
(Inherited from ITaskMonitor) |
| PublishingTask | Gets the corresponding Publishing Task to monitor. |
| PubTargetID | Gets the ID of the Publishing Target to which the corresponding Publishing Task publishes. |
| PubTargetName | Gets the name of the Publishing Target to which the corresponding Publishing Task publishes. |
| RootPageID | Gets the ID of the Root Page to be published in the corresponding Publishing Task. |
| Session |
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity) |
| SessionId |
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity) |
 | StartTime | Gets the start time of the corresponding Publishing Task in ISO-8601 format. |
| SubmitTime | Gets the submission time of the corresponding Publishing Task in ISO-8601 format. |
| SubmitUserID | Gets the login name of the User that submitted the corresponding Publishing Task. |
| TaskID | Gets the ID of the corresponding Publishing Task to monitor. |
| TotalWeight |
Gets the total weight of all publishing Steps.
(Inherited from ITaskMonitor) |
Methods| Name | Description | |
|---|---|---|
 | Add |
Adds a new Step to monitor to this task.
(Inherited from ITaskMonitor) |
| AdvanceStep |
Marks the previous Ongoing Step as COMPLETED.
(Inherited from ITaskMonitor) |
| Assets | Retrieve the IDs of the Assets to be published by the corresponding Publishing Task. |
| Clear |
Clears the Steps collection.
(Inherited from ITaskMonitor) |
| Pages | Retrieve the IDs of the Pages to be published by the corresponding Publishing Task. |
| Remove |
Removes a Step to monitor from this task.
(Inherited from ITaskMonitor) |
| Reset |
Marks the monitor as inactive.
(Inherited from ITaskMonitor) |
| Shutdown |
Shuts down the monitor and issues the PublishCompleteevent.
This method is called by Publishing Task upon completing the task.
(Inherited from ITaskMonitor) |
| Step(Int32) |
Retrieves a Step by its index.
(Inherited from ITaskMonitor) |
| Step(String) |
Retrieves a Step by its unique ID.
(Inherited from ITaskMonitor) |
| Steps |
Retrieves the collection of Steps for the task to be monitored.
(Inherited from ITaskMonitor) |
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity) |
| ValidateData |
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity) |
| ValidateUserPermission |
Validates the user permission on the current entity. Implemented by concrete inheriting types.
It is called automatically upon saving an entity.
(Inherited from IEntity) |
Events| Name | Description | |
|---|---|---|
 | AfterEntitySave |
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents) |
| BeforeEntitySave |
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents) |
RemarksThe publishing target and publishing task monitor have a one-to-one relationship.
See Also