IPublishingManager Interface

Represents the manager object that provides the means to query and manage the following publishing- and runtime-related objects:

Publishing Targets, Publishing Profiles, Structured Url Maps, Runtime Redirects, Replication System, Publishing Tasks and Replication Tasks.

It also provides ways to manage InSite Search configuration of CMS published content.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308

Syntax

C++

Copy

public interface IPublishingManager : ITransactionalEntity, 
	IDisposable

Public Interface IPublishingManager
	Inherits ITransactionalEntity, IDisposable

public interface class IPublishingManager : ITransactionalEntity, 
	IDisposable

type IPublishingManager =  
    interface
        interface ITransactionalEntity
        interface IDisposable
    end

The IPublishingManager type exposes the following members.

Properties

	Name	Description
	ContentStore	Gets the Content Store. (Inherited from ITransactionalEntity.)
	CurrentTask	Gets the Publishing Task Monitor of the Publishing Task that is being executed. If no publishing task is being executed at the time of property call, this method returns null.
	CurrentUser	Gets the Operating User for the Session . (Inherited from ITransactionalEntity.)
	ForceIncrementPublishWithNoChangedPages	Gets/sets whether to do incremental publishes, even when no pages are changed. This is an one time set property. Set it before submitting publishes. Upon submission it will reset itself to false. The value of this property will not persist.
	PendingTasks	Gets the collection of pending Publishing Tasks.
	Session	Gets the User Session that this manager instance was initiated from. (Inherited from ITransactionalEntity.)

Top

Methods

	Name	Description
	AddProfile	Adds a new blank Publishing Profile.
	AddRedirect	Adds a new Redirect entry
	AddReplicationTaskMonitor	Creates a new Replication Task Monitor for a Replication Target to track the replication progress for this target.
	AddSearchFieldGlobalException	Adds a new InSite Search Field Exception that applies to all page types.
	AddSearchSchemaException	Adds a new InSite Search Schema Exception.
	AddTarget	Creates a new Publishing Target.
	CreatePreviewTask	Creates a preview task to gather information after the next publish with given parameters
	CreateSearchConfig
	CreateTask	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.
	DeepCloneT, TManager	Duplicates an object instance, not including its unique ID. (Inherited from ITransactionalEntity.)
	DeleteSearchConfig
	GetSearchConfig
	Profile	Retrieves a Publishing Profile by its unique ID.
	Profiles(String)	Retrieves a collection of Publishing Profiles by their unique IDs.
	Profiles(Int32, Int32, Int32)	Retrieves the collection of all Publishing Profiles.
	ProfilesCount	Gets the count of Publishing Profiles.
	PublishingProfilesSerialize	Produces the XML serialization of the Publishing Profiles collection. The result matches the XML format of PublishingProfiles.xml prior to CMS 9.0.
	PublishingTargetByName	Retrieves a Publishing Target by name.
	PublishingTargetsSerialize	Produces the XML serialization of the Publishing Targets collection. The result matches the XML format of publishingTargets.xml prior to CMS 9.0.
	QuickWrite	Creates a temporary Write Session to quickly write something outside the current Session and transaction. This is a way to bypass the transaction and quickly put something into the content store. (Inherited from ITransactionalEntity.)
	Redirect	Retrieves a Redirect entry by its unique ID.
	Redirects	Retrieves the collection of runtime Redirect entries in a paginated manner.
	RemoveProfile	Removes a Publishing Profile from the collection.
	RemoveRedirect	Removes a Redirect entry by its unique ID.
	RemoveReplicationTaskMonitor	Removes a Replication Task Monitor by a specified unique ID.
	RemoveSearchFieldGlobalException	Removes a InSite Search Field Exception that applies to all page types.
	RemoveSearchSchemaException(ISchema)	Removes InSite Search Schema Exception entry for specified Schema.
	RemoveSearchSchemaException(ISearchSchemaException)	Removes a InSite Search Schema Exception entry.
	RemoveTarget	Removes a Publishing Targets.
	RemoveTask	Removes a pending Publishing Task.
	ReplicationTaskMonitor	Retrieves a Replication Task Monitor by its unique ID.
	ReplicationTaskMonitors	Retrieves the collection of Replication Task Monitors.
	Replicators	Retrieves the collection of Replicators. Each replicator belongs to a Publishing Target.
	SearchFieldGlobalExceptions	Retrieves a collection of the InSite Search Field Exception entries that apply to all page types.
	SearchFieldGlobalExceptionsCount	Gets the count of InSite Search Field Exceptions that apply to all page types.
	SearchSchemaExceptions	Retrieves a collection of InSite Search Schema Exception entries.
	SearchSchemaExceptionsCount	Retrieves the count of InSite Search Schema Exception entries for all or specific Publishing Targets.
	SerializeRedirects	Produces XML serialization of the Redirect entries that apply to the given Publishing Target. The Dynamic Site Server depends on the results of this serialization to control redirects.
	Target	Retrieves a Publishing Target by its unique ID.
	Targets(String)	Retrieves a collection of Publishing Targets, by their unique IDs.
	Targets(Int32, IPublishingProfile, Int32, Int32)	Retrieves either the collection of all Publishing Targets or the collection of publishing targets that belongs to the specified Publishing Profile.
	TargetsCount	Gets the count of Publishing Targets.
	Task	Retrieves a Publishing Task by its unique ID.
	TaskMonitor	Retrieves a Publishing task monitor by its unique ID.
	TaskMonitors	Retrieves the collection of Publishing Task Monitors that are used to monitor the status of pending and ongoing Publishing Tasks.
	TasksCount	Retrieves the number of pending and ongoing Publishing Tasks.
	UpdateRedirect	Update the given Redirect with new content.
	UrlMap	Retrieves a URL Maps Collection by its unique ID.
	UrlMapEntry(String, IPublishingTarget)
	UrlMapEntry(String, String)
	UrlMapEntry(IContentItem, IPublishingTarget)
	UrlMapEntry(IContentItem, String)
	UrlMaps	Retrieves all URL Map Collections

Top

Remarks

Like all manager objects, instances of this manager are retrieved from an IUserSession object, and it only works within that session.

Copy

using (IUserSession session = store.OpenReadSession(currentUser))
{
       IPublishingManager taxonomyManager = session.PublishingManager;
       ...
}

Examples

The Publishing Manager can serialize two output XML documents: Publishing Targets and Publishing Profiles.

Publishing Target serialization resembles the the publishingtargets.xml file before CMS 9.0:

XML

Copy

<?xml version="1.0" encoding="utf-8"?>
<PublishingTargets>
  <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>
  <PublishingTarget ID="PublishingTargets/3" Name="Staging" PublishFolder="stagin" RootPageID="x2" Transform="false" UserAgentSearchString="" SiteSearchString="" UseStructuredURL="true" HomePageID="x11" NotFoundID="x7" URLExtension=""
                    URLSeparator="-" ForceLowerCaseURL="true" AutoRedirectCanonicalURL="true" IncludeFoldersInURL="true" NormalizeURLSeparators="false" BaseURL="" DynamicPublishing="true" UseExternalPreviewURL="true" 
                    ExternalPreviewURL="/cms80/DssPreview/IGXDynamicPreview" ICEFieldMarkupUpdateURL="/cms80/DssPreview/IGXDTICEUpdate" GlobalContentRoot="">
    <Replication DoReplication="false" SimultaneousReplication="false"/>
  </PublishingTarget>
</PublishingTargets>

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSIPublishingTarget

Ingeniux.CMSIPublishingProfile