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.CMSAssembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxIPublishingTask 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
)
Function CreateTask (
pages As IEnumerable(Of IPublishingPageEntry),
assets As IEnumerable(Of IPublishingContentItemEntry),
incremental As Boolean,
pubTarget As IPublishingTarget,
postPageFilterCallback As Action(Of IEnumerable(Of IPublishingPageEntry), IEnumerable(Of IPublishingContentItemEntry)),
Optional replicate As Boolean = true,
Optional alwaysIncludePages As Boolean = true,
Optional alwaysIncludeAssets As Boolean = true,
Optional dependenciesToProcess As IDependencyNode() = Nothing
) As IPublishingTask
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,
array<IDependencyNode^>^ dependenciesToProcess = nullptr
)
abstract CreateTask :
pages : IEnumerable<IPublishingPageEntry> *
assets : IEnumerable<IPublishingContentItemEntry> *
incremental : bool *
pubTarget : IPublishingTarget *
postPageFilterCallback : Action<IEnumerable<IPublishingPageEntry>, IEnumerable<IPublishingContentItemEntry>> *
?replicate : bool *
?alwaysIncludePages : bool *
?alwaysIncludeAssets : bool *
?dependenciesToProcess : IDependencyNode[]
(* Defaults:
let _replicate = defaultArg replicate true
let _alwaysIncludePages = defaultArg alwaysIncludePages true
let _alwaysIncludeAssets = defaultArg alwaysIncludeAssets true
let _dependenciesToProcess = defaultArg dependenciesToProcess null
*)
-> IPublishingTask Parameters
- pages IEnumerableIPublishingPageEntry
- Collection of pages to be published
- assets IEnumerableIPublishingContentItemEntry
[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 Boolean
- 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 IPublishingTarget
- The target to publish pages to
- postPageFilterCallback ActionIEnumerableIPublishingPageEntry, IEnumerableIPublishingContentItemEntry
- The action to call after filter out the Pages that don't need to be published
- replicate Boolean (Optional)
- Whether or not to perform replication after the publish completes. Default is to perform replication.
- alwaysIncludePages Boolean (Optional)
[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 Boolean (Optional)
[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 IDependencyNode (Optional)
- The dependencies to be processed to content processors of the Publishing Target
Return Value
IPublishingTaskThe created and queue publishing task
Exceptions| Exception | Condition |
|---|
| InvalidOperationException | During an incremental publish, when there are no pages or components that have been added or updated since the most-recent publish. |
RemarksPublish 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 AlsoReference
IPublishingContentProcessor