Click or drag to resize

IPublishingTarget Interface


Represents the location to which a list of marked Pages is published as well as the settings on how the published contents get replicated. Also provides information on how the Dynamic Site Server hosts the published content in a runtime environment.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.5.94
Syntax
public interface IPublishingTarget : IEntity<IPublishingManager>, 
	IEntity, IEntityEvents, IContentItemMarking, IPublishingTargetEvents

The IPublishingTarget type exposes the following members.

Properties
  NameDescription
Public propertyArchived
Gets the archived value of this entity
(Inherited from IEntity.)
Public propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyEnableDynamicPublishing Obsolete.
Gets/sets whether Dynamic Publishing is enabled for this Publishing Target.
Public propertyExcludedDirectories
Gets/sets the asset directories that will be excluded during publish. Any files in these directories will not be copied to the target location.
Public propertyExcludedFiles
Gets/sets the asset files that will be excluded during publish.
Public propertyExcludeLingualMaps
Gets/sets whether to exclude lingual maps, during publishing and preview
Public propertyExternalPreviewUrl
Gets/sets the URL for previewing Pages with this Publishing Target on the Ingeniux CMS user interface.
Public propertyGlobalContentRoot
Get and sets the root Location that contains all the components that also needs to be published. This setting is only effective when the global content root is not under the Root Page.
Public propertyIceFieldMarkupUpdateUrl
Gets/sets the URL for providing markup feedback upon updating a Page's Element value, via In-Context Editing or Page Builder.
Public propertyLastAssetPublishDate
Gets the time when this publishing target last performed an asset only publish. The property returns null if this publishing target never published assets only.
Public propertyLastModified
Gets the date when the entity was most recently modified.
(Inherited from IEntity.)
Public propertyLastModifiedUser
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.)
Public propertyLastPublishDate
Gets the time when this publishing target last performed a publish. The property returns null if this publishing target never published.
Public propertyManager
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.)
Public propertyMVCRenderingForMFO
Gets/sets whether to support MVC rendering in MFO publishing
Public propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertyPresentationFormatter
Gets/sets the full class name of the formatter for presentations formatting on this Publishing Target.
Public propertyProfile
Gets/sets the Publishing Profile to which this Publishing Target belongs.
Public propertyPublishFolder
Gets/sets the full physical path of the folder to which content is published.
Public propertyPublishingSystemSecurity
Gets/sets the security settings for this publishing target.
Public propertyRelativePublishFolder
Gets the name of the folder to which content is published. It is located under the pub folder.
Public propertyRootPage
Gets/sets the root Page for this target. Pages (not components) must be under this root page in order to be marked for publish. Only marked-for-publish pages under this page will be published.
Public propertySession
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.)
Public propertySessionId
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.)
Public propertySiteSearchString
Gets/sets the search string for site branding. This setting only applies when theTransform property is true, since transforms on publishes behave very similarly to a browser request on a page at runtime.
Public propertySURLSettings
Gets/sets the structured URL settings for this publishing target.
Public propertyTransform
Gets/sets whether to fully expand the Pages and apply XSLT style sheets during publishing. Set this property to true for publishing to non–Dynamic Site Server content locations.
Public propertyUseExternalPreviewUrl Obsolete.
Gets/sets whether the Publishing Target uses an external preview URL.
Public propertyUserAgentSearchString
Gets/sets the search string for the User Agent. This setting only applies when the Transform property is true, transforms on publishes behave very similarly to a browser request on a page at runtime.
Top
Methods
  NameDescription
Public methodAssetMap
Retrieves the Asset Map for this publishing target.
Public methodCanMarkContentItemT
Checks whether a content item can be marked for publish on this Publishing Target.
(Inherited from IContentItemMarking.)
Public methodCanMarkPage
Checks whether a Page can be marked on this publishing target.
Public methodMarkContentItemForPublishT
Marks or unmarks a Content Item for publish on this Publishing Target.
(Inherited from IContentItemMarking.)
Public methodMarked(String)
Checks whether the Page specified is marked on this publishing target.
Public methodMarked(IPage)
Checks whether the specified Page is marked on this publishing target.
Public methodMarkedT(T)
Checks whether a Content Item is marked on this Publishing Target.
(Inherited from IContentItemMarking.)
Public methodMarkedContentItemCountT
Retrieves the count of all marked Content Items of specific type on this Publishing Target.
(Inherited from IContentItemMarking.)
Public methodMarkedContentItemsT
Retrieves all marked Content Item Versions on this Publishing Target.
(Inherited from IContentItemMarking.)
Public methodMarkedOnContentItemCurrentVersionT
Checks whether the current version of a Content Item is marked for publish on this Publishing Target.
(Inherited from IContentItemMarking.)
Public methodMarkedOnContentItemVersionT
Checks whether a Content Item Version, is marked on this Publishing Target.
(Inherited from IContentItemMarking.)
Public methodMarkedOnPageCurrentVersion
Checks whether the specified Page is marked for publish on its current checked-in version.
Public methodMarkedOnPageVersion
Checks whether the specified Page is marked on its specific Version.
Public methodMarkedPages
Retrieves the collection of Page Versions that are marked on this publishing target.
Public methodMarkedPagesCount
Gets the count of Pages marked on this Publishing Target on any version.
Public methodMarkedVersionForContentItem
Retrieves the marked Version of a specified Content Item on this publishing target
Public methodMarkedVersionForPage(String)
Retrieves the marked version number of the Page with a specified ID.
Public methodMarkedVersionForPage(IPage)
Retrieves the marked Version of the specified Page on this publishing target.
Public methodMarkPageForPublish
Marks or unmarks a Page to publish, on a specified version number, on this publishing target.
Public methodPendingPublishes
Retrieves the collection of pending Publishing Tasks issued by this Publishing Target.
Public methodPropagateVersion(IAsset)
Sets the marked version to current version on an Asset
Public methodPropagateVersion(IAssetFolder)
Sets the marked version to current version on all descendant Assets under a Asset Folder.
Public methodPropagateVersion(IPage, Boolean)
Sets the marked version to current version on a Page.
Public methodPublish

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 methodPublishAssets

Performs publishes on multiple Asset items, 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 methodPublishPages

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 methodReplicator
Retrieves the Replicator object, which is in charge of performing replication tasks.
Public methodRepublishAssets
Performs publish on an Asset, or descendants of an Asset Folder.
Public methodRepublishPage

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 methodSerializeForReports
Override for Serialize that uses legacy version numbering.
Public methodSetRelativePublishFolder
Set the relative pub folder
Public methodTouch
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.)
Public methodUrlMap
Retrieves the URL Map for this publishing target.
Public methodValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public methodValidateUserPermission
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
  NameDescription
Public eventAfterEntitySave
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.)
Public eventAfterPublishingTargetMarkForPublishChange
This event is fired after any Publishing Target is marked for publish, unmarked for publish, or has its marking version changed.
(Inherited from IPublishingTargetEvents.)
Public eventBeforeEntitySave
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.)
Public eventBeforePublish
This event is fired before a Publishing Task is submitted.
(Inherited from IPublishingTargetEvents.)
Public eventBeforePublishingTargetMarkForPublishChange
This event is fired before any Publishing Target is marked for publish, unmarked for publish, or has its marking version changed.
(Inherited from IPublishingTargetEvents.)
Public eventPublished
This event is fired after a Publishing Task is completed.
(Inherited from IPublishingTargetEvents.)
Top
Examples
Serialization of a publishing target is very similar to the publishingtargets.xml file's PublishingTarget element before CMS 9.0:
XML
<PublishingTarget ID="PublishingTargets/1" Name="Production" PublishFolder="production" RootPageID="x2" UserAgentSearchString="" SiteSearchString="" Transform="false" ReplicationTarget="" 
                  ReplicationTargetModule="" LastPublishDate="20140314T23:49:39" UseStructuredURL="true" HomePageID="x11" NotFoundID="x722" URLExtension="" URLSeparator="-" ForceLowerCaseURL="true" 
                  AutoRedirectCanonicalURL="true" IncludeFoldersInURL="false" NormalizeURLSeparators="true" BaseURL="http://services1.ingeniux.com/centraulv75rt/" UseExternalPreviewURL="true" DynamicPublishing="true"
                  ExternalPreviewURL="/cms80/DssPreview/IGXDynamicPreview" ICEFieldMarkupUpdateURL="/cms80/DssPreview/IGXDTICEUpdate" GlobalContentRoot="">
  <Replication DoReplication="false" SimultaneousReplication="false"/>
  <Page ID="x2" Version="0"/>
  <Page ID="x11" Version="2"/>
  <Page ID="x37" Version="0"/>
</PublishingTarget>
See Also