Click or drag to resize

IPublishingManagerCreateTask Method


Creates a new publishing task and pushes this task into publishing queue. Tasks in the queue are executed in sequence and purged after being executed.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax
IPublishingTask CreateTask(
	IEnumerable<IPublishingPageEntry> pages,
	IEnumerable<IPublishingContentItemEntry> assets,
	bool incremental,
	IPublishingTarget pubTarget,
	Action<IEnumerable<IPublishingPageEntry>, IEnumerable<IPublishingContentItemEntry>> postPageFilterCallback,
	bool replicate = true,
	bool alwaysIncludePages = true,
	bool alwaysIncludeAssets = true,
	IDependencyNode[] dependenciesToProcess = null
)

Parameters

pages
Type: System.Collections.GenericIEnumerableIPublishingPageEntry
Collection of pages to be published
assets
Type: System.Collections.GenericIEnumerableIPublishingContentItemEntry

[Missing <param name="assets"/> documentation for "M:Ingeniux.CMS.IPublishingManager.CreateTask(System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingPageEntry},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry},System.Boolean,Ingeniux.CMS.IPublishingTarget,System.Action{System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingPageEntry},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry}},System.Boolean,System.Boolean,System.Boolean,Ingeniux.CMS.IDependencyNode[])"]

incremental
Type: SystemBoolean
Incremental or full publish. Incremental publishes only add or update pages and components that have been added or changed. Full publishes publish all marked pages and components; delete pages and components that are no longer marked; and clean up assets at the publishing target location.
pubTarget
Type: Ingeniux.CMSIPublishingTarget
The target to publish pages to
postPageFilterCallback
Type: SystemActionIEnumerableIPublishingPageEntry, IEnumerableIPublishingContentItemEntry
The action to call after filter out the Pages that don't need to be published
replicate (Optional)
Type: SystemBoolean
Whether or not to perform replication after the publish completes. Default is to perform replication.
alwaysIncludePages (Optional)
Type: SystemBoolean

[Missing <param name="alwaysIncludePages"/> documentation for "M:Ingeniux.CMS.IPublishingManager.CreateTask(System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingPageEntry},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry},System.Boolean,Ingeniux.CMS.IPublishingTarget,System.Action{System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingPageEntry},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry}},System.Boolean,System.Boolean,System.Boolean,Ingeniux.CMS.IDependencyNode[])"]

alwaysIncludeAssets (Optional)
Type: SystemBoolean

[Missing <param name="alwaysIncludeAssets"/> documentation for "M:Ingeniux.CMS.IPublishingManager.CreateTask(System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingPageEntry},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry},System.Boolean,Ingeniux.CMS.IPublishingTarget,System.Action{System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingPageEntry},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry}},System.Boolean,System.Boolean,System.Boolean,Ingeniux.CMS.IDependencyNode[])"]

dependenciesToProcess (Optional)
Type: IDependencyNode
The dependencies to be processed to content processors of the Publishing Target

Return Value

Type: IPublishingTask
The created and queue publishing task
Exceptions
ExceptionCondition
InvalidOperationExceptionDuring an incremental publish, when there are no pages or components that have been added or updated since the most-recent publish.
Remarks

Publish Tasks are centered around pages and components, not assets, for incremental publishes.

If no pages or components changed since last publish, it doesn't matter whether any assets are changed. The publish will not occur.

See Also