IPublishingManagerCreatePreviewTask Method
|
Creates a preview task to gather information after the next publish with given parameters
Namespace:
Ingeniux.CMS
Assembly:
Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax IPublishingPreviewTask CreatePreviewTask(
IEnumerable<IPublishingContentItemEntry> pages,
IEnumerable<IPublishingContentItemEntry> assets,
bool incremental,
IPublishingTarget pubTarget,
bool pagesPublish = true,
bool assetsPublish = true
)
Function CreatePreviewTask (
pages As IEnumerable(Of IPublishingContentItemEntry),
assets As IEnumerable(Of IPublishingContentItemEntry),
incremental As Boolean,
pubTarget As IPublishingTarget,
Optional pagesPublish As Boolean = true,
Optional assetsPublish As Boolean = true
) As IPublishingPreviewTask
IPublishingPreviewTask^ CreatePreviewTask(
IEnumerable<IPublishingContentItemEntry^>^ pages,
IEnumerable<IPublishingContentItemEntry^>^ assets,
bool incremental,
IPublishingTarget^ pubTarget,
bool pagesPublish = true,
bool assetsPublish = true
)
abstract CreatePreviewTask :
pages : IEnumerable<IPublishingContentItemEntry> *
assets : IEnumerable<IPublishingContentItemEntry> *
incremental : bool *
pubTarget : IPublishingTarget *
?pagesPublish : bool *
?assetsPublish : bool
(* Defaults:
let _pagesPublish = defaultArg pagesPublish true
let _assetsPublish = defaultArg assetsPublish true
*)
-> IPublishingPreviewTask
Parameters
- pages
- Type: System.Collections.GenericIEnumerableIPublishingContentItemEntry
Collection of pages to be evaluated - assets
- Type: System.Collections.GenericIEnumerableIPublishingContentItemEntry
Collection of assets to be evaluated - 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 - pagesPublish (Optional)
- Type: SystemBoolean
[Missing <param name="pagesPublish"/> documentation for "M:Ingeniux.CMS.IPublishingManager.CreatePreviewTask(System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry},System.Boolean,Ingeniux.CMS.IPublishingTarget,System.Boolean,System.Boolean)"]
- assetsPublish (Optional)
- Type: SystemBoolean
[Missing <param name="assetsPublish"/> documentation for "M:Ingeniux.CMS.IPublishingManager.CreatePreviewTask(System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IPublishingContentItemEntry},System.Boolean,Ingeniux.CMS.IPublishingTarget,System.Boolean,System.Boolean)"]
Return Value
Type:
IPublishingPreviewTaskThe created and queue publishing task
See Also