IPublishingTarget Methods Ingeniux CMS Content Store API

The IPublishingTarget type exposes the following members.

Methods

  Name Description
Public method CanMarkPage
Checks whether a Page can be marked on this publishing target.
Public method Marked(String)
Checks whether the Page specified is marked on this publishing target.
Public method Marked(IPage)
Checks whether the specified Page is marked on this publishing target.
Public method MarkedOnPageCurrentVersion
Checks whether the specified Page is marked for publish on its current checked-in version.
Public method MarkedOnPageVersion
Checks whether the specified Page is marked on its specific Version.
Public method MarkedPages
Retrieves the collection of Page Versions that are marked on this publishing target.
Public method MarkedPagesCount
Gets the count of Pages marked on this Publishing Target on any version.
Public method MarkedVersionForPage(String)
Retrieves the marked version number of the Page with a specified ID.
Public method MarkedVersionForPage(IPage)
Retrieves the marked Version of the specified Page on this publishing target.
Public method MarkPageForPublish
Marks or unmarks a Page to publish, on a specified version number, on this publishing target.
Public method PendingPublishes
Retrieves the collection of pending Publishing Tasks issued by this Publishing Target.
Public method PropagateVersion
Public method Publish

Performs a publish on this publishing target, including all Pages marked on this target as candidates to be published.

For a non-Transform-on-publish target, this action creates XML files for pages and components marked for this target; generates all metadata files needed for the Dynamic Site Server; and copies all updated assets.

For a Transform-on-publish target, Pages will be fully expanded and XSLT transformed, then saved to target folder in a structural format. Updated assets are also copied.

Public method PublishPages

Performs publishes on multiple root Pages, or together with their descendants, toward this publishing target.

For a non-Transform-on-publish target, this action creates XML files for pages and components marked for publishing on this target; generates all metadata files needed for the Dynamic Site Server; and copies over all updated assets.

For a Transform-on-publish target, Pages are fully expanded and XSLT transformed, then saved to target folder in a structured format. Updated assets are also copied over.

Public method Replicator
Retrieves the Replicator object, which is in charge of performing replication tasks.
Public method RepublishPage

Performs publish on a Page, or the page and its descendants, towards this publishing target.

For a non-Transform-on-publish target, this action creates XML files for pages and components marked for this target; generates all metadata files needed for the Dynamic Site Server; and copies over all updated assets.

For a Transform-on-publish target, Pages will be fully expanded and XSLT transformed, then saved to target folder in a structured format. Updated assets are also copied over.

Public method SerializeForReports
Override for Serialize that uses legacy version numbering.
Public method SetRelativePublishFolder
Set the relative pub folder
Public method UrlMap
Retrieves the URL Map for this publishing target.
Public method ValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public method 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
See Also

Reference