IPublishingTask Interface

Ingeniux CMS Content Store API

Represents a task to publish a set of Pages and assets.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)

Syntax

public interface IPublishingTask : IEntity, 
	IEntityEvents, IPublishingTaskEvents

Public Interface IPublishingTask
	Inherits IEntity, IEntityEvents, IPublishingTaskEvents

public interface class IPublishingTask : IEntity, 
	IEntityEvents, IPublishingTaskEvents

type IPublishingTask =  
    interface
        interface IEntity
        interface IEntityEvents
        interface IPublishingTaskEvents
    end

The IPublishingTask type exposes the following members.

Properties

	Name	Description
	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
	IsFullPublish	Gets whether this task is for a full publish or an incremental publish. A full publish will forces the publication of marked pages, changed or not, and cleans up the target location. An incremental publish only publishes changed pages and doesn't perform any clean up.
	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.)
	Name	Gets and sets the entity's name. (Inherited from IEntity.)
	PubDoneFilename	Gets the "publishing done" marker file name.
	PublishingTargetID	Gets the ID of the Publishing Target toward which to publish.
	PublishingTargetName	Gets the name of the Publishing Target toward which to publish.
	RootPageID	Gets the ID of the root Page of the Publishing Target toward which to publish.
	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.)
	SubmitServerGuid	Gets the unique ID of the CMS server that received this submission.
	SubmitTime	Gets the time when this task was submited.
	SubmitUserID	Gets the user name of the User that submitted this task.
	SubmitUserIP	Gets the IP address of the computer where the user submitted the task.
	SyncDoneFilename	Gets the "synchronization/replication done" marker file name.

Top

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.
	PagesCount	Retrieves the count of Pages to be published.
	ReadyToExecute	Checks whether this publishing task is ready to be executed.
	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.)

Top

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.)
	BeginPublish	This event is fired when a publish starts. (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 occurrs 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.)

Top

Examples

Serialization:

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>

Reference

Ingeniux.CMS Namespace