IPublishing
|
Represents a task to publish a set of Pages and assets.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxThe IPublishingTask type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity) |
| AuthCookie | Gets/sets the auth cookie for executing this publishing task |
| ContentDependencies | Gets the content dependencies that will be run through post process filters |
| Created |
Gets the entity's creation date.
(Inherited from IEntity) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity) |
| ForcedIncremental | Gets whether this publishing system bypassed change time checking and proceed with a forced incremental 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) |
| PubDoneFilename | Gets the "publishing done" marker file name. |
| 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) |
| SiteUrl | Gets/sets the url of the site executing this publishing task |
| StartTime | Gets the time when this task began execution. |
| SubmitServerGuid | Gets the unique ID of the CMS server that received this submission. |
| SyncDoneFilename | Gets the "synchronization/replication done" marker file name. |
Methods| Name | Description | |
|---|---|---|
 | AddPage | Adds a new Page to be published. |
| Execute | Executes the publishing task. |
| Pages | Retrieves the information of the Pages to be published. |
| ReadyToExecute | Checks whether this publishing task is ready to be executed. |
| 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) |
| AssetPublishStepUpdated |
This event is fired when a Publishing Task finishes publishing one Page.
(Inherited from IPublishingTaskEvents) |
| BeforeEntitySave |
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents) |
| BeginPublish |
This event is fired when a publish starts.
(Inherited from IPublishingTaskEvents) |
| PostProcessContentStepUpdated |
This event is fired when a Publishing Content Processor processed one dependency entry
(Inherited from IPublishingTaskEvents) |
| PublishComplete |
This event is fired when a Publishing Task finishes executing.
(Inherited from IPublishingTaskEvents) |
| PublishingErrorOccurred |
This event is fired when any error occurs during Publishing Task execution.
(Inherited from IPublishingTaskEvents) |
| PublishStepAdvanced |
This event is fired when Publishing Task advances to next step (e.g., when a publish task finishes copying images).
(Inherited from IPublishingTaskEvents) |
| PublishStepUpdated |
This event is fired when a Publishing Task finishes publishing one Page.
(Inherited from IPublishingTaskEvents) |
Example
Serialization:
XML
<PublishTask PubDoneFileName="publishdone.txt" SyncDoneFilename="synchdone.lck"> <Settings> <IsFullPublish>true</IsFullPublish> <PublishingTarget ID="PublishingTargets/23" Name="Production" /> <RootPage>x3</RootPage> <Submitted UTC="true">20140618T19:21:14</Submitted> <SubmitUser UserID="ingeniux\\admin1" IPAddress="10.10.2.254" ServerId="5B9D6571-F894-45EF-AD83-D930CEF3E89D" /> </Settings> <Pages Count="3"> <Page ID="x45" Version="9" TransformOnPublish="false" /> <Page ID="x789" Version="2" TransformOnPublish="false" /> <Page ID="x6" Version="13" TransformOnPublish="false" /> </Pages> </PublishTask>
See Also