Click or drag to resize

IPublishingTask Interface
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.308
Syntax
Copy
public interface IPublishingTask : IEntity<IPublishingManager>, 
	IEntity, IEntityEvents, IPublishingTaskEvents

The IPublishingTask type exposes the following members.

Properties
  NameDescription
Public propertyArchived
Gets/sets the archived value of this entity
(Inherited from IEntity.)
Public propertyAuthCookie
Gets/sets the auth cookie for executing this publishing task
Public propertyContentDependencies
Gets the content dependencies that will be run through post process filters
Public propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyForcedIncremental
Gets whether this publishing system bypassed change time checking and proceed with a forced incremental publish
Public propertyLastModified
Gets the date when the entity was most recently modified.
(Inherited from IEntity.)
Public propertyLastModifiedUser
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.)
Public propertyManager
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.)
Public propertyPubDoneFilename
Gets the "publishing done" marker file name.
Public propertySession
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.)
Public propertySessionId
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.)
Public propertySiteUrl
Gets/sets the url of the site executing this publishing task
Public propertyStartTime
Gets the time when this task began execution.
Public propertySubmitServerGuid
Gets the unique ID of the CMS server that received this submission.
Public propertySyncDoneFilename
Gets the "synchronization/replication done" marker file name.
Top
Methods
  NameDescription
Public methodAddPage
Adds a new Page to be published.
Public methodExecute
Executes the publishing task.
Public methodPages
Retrieves the information of the Pages to be published.
Public methodReadyToExecute
Checks whether this publishing task is ready to be executed.
Public methodTouch
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.)
Public methodValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public methodValidateUserPermission
Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity.
(Inherited from IEntity.)
Top
Events
  NameDescription
Public eventAfterEntitySave
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.)
Public eventAssetPublishStepUpdated
This event is fired when a Publishing Task finishes publishing one Page.
(Inherited from IPublishingTaskEvents.)
Public eventBeforeEntitySave
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.)
Public eventBeginPublish
This event is fired when a publish starts.
(Inherited from IPublishingTaskEvents.)
Public eventPostProcessContentStepUpdated
This event is fired when a Publishing Content Processor processed one dependency entry
(Inherited from IPublishingTaskEvents.)
Public eventPublishComplete
This event is fired when a Publishing Task finishes executing.
(Inherited from IPublishingTaskEvents.)
Public eventPublishingErrorOccurred
This event is fired when any error occurs during Publishing Task execution.
(Inherited from IPublishingTaskEvents.)
Public eventPublishStepAdvanced
This event is fired when Publishing Task advances to next step (e.g., when a publish task finishes copying images).
(Inherited from IPublishingTaskEvents.)
Public eventPublishStepUpdated
This event is fired when a Publishing Task finishes publishing one Page.
(Inherited from IPublishingTaskEvents.)
Top
Examples
Serialization:
XML
Copy
 <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

Reference

Ingeniux.CMS Namespace
IPublishingTaskInfo
IPublishingPreviewTask