IContentStore Interface

Represents the object that hosts the content of a CMS instance. There should be only one instance of this object created per App Domain. For a CMS Site, this object is always stored as an application variable that persists throughout the CMS application's lifecycle. Any integration work at the CSAPI level should only use one ContentStore instance per App Domain.

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

Syntax

C++

Copy

public interface IContentStore : IDisposable, 
	IContentStoreEvents, IEntityEvents, IPublishingTargetEvents, IPublishingTaskEvents, IPageEvents, 
	IAssetEvents, ISiteEvents, IAssetManagerEvents, ITaxonomyEvents, IUserEvents, 
	IUserGroupEvents, IWorkflowTransitionEvents, ICategoryEvents

Public Interface IContentStore
	Inherits IDisposable, IContentStoreEvents, IEntityEvents, IPublishingTargetEvents, 
	IPublishingTaskEvents, IPageEvents, IAssetEvents, ISiteEvents, IAssetManagerEvents, 
	ITaxonomyEvents, IUserEvents, IUserGroupEvents, IWorkflowTransitionEvents, ICategoryEvents

public interface class IContentStore : IDisposable, 
	IContentStoreEvents, IEntityEvents, IPublishingTargetEvents, IPublishingTaskEvents, IPageEvents, 
	IAssetEvents, ISiteEvents, IAssetManagerEvents, ITaxonomyEvents, IUserEvents, 
	IUserGroupEvents, IWorkflowTransitionEvents, ICategoryEvents

type IContentStore = 
    interface
        interface IDisposable
        interface IContentStoreEvents
        interface IEntityEvents
        interface IPublishingTargetEvents
        interface IPublishingTaskEvents
        interface IPageEvents
        interface IAssetEvents
        interface ISiteEvents
        interface IAssetManagerEvents
        interface ITaxonomyEvents
        interface IUserEvents
        interface IUserGroupEvents
        interface IWorkflowTransitionEvents
        interface ICategoryEvents
    end

The IContentStore type exposes the following members.

Properties

	Name	Description
	Archiver
	AuditTrail	Gets the AuditTrail object.
	Logger	Gets the logger of CSAPI. With this object, integraters can directly write to the CMS design-time log.
	ServerGuid	Gets the unique IDs of the web application instance.
	UniqueId	Gets the globally unique id of the content store
	XmlDirectoryPath	Gets the XML directory path of the ContentStore.

Top

Methods

	Name	Description
	GetStartingUser	Gets a starting User object to open a session.
	IsStale	Returns whether a given index is stale.
	LastIndexTimestamp	Returns the last time a given index was indexed.
	OpenReadSession	Opens a read-only session. This session doesn't track changes to objects that were retrieved within this session, nor does it track created or deleted objects. It is not in charge of saving changes, only for reading.
	OpenWriteSession	Opens a read/write session. This session automatically tracks changes made to any objects that were retrieved within this session. It also tracks the newly created and to-be-deleted objects. All saves occur when the session is disposed. If any exceptions occurred before the session is closed, no changes are applied. This system makes it easy to perform transactional changes and prevents any partial changes due to errors before the session is disposed.
	StartIndexing	Starts indexing on the document store.
	StopIndexing	Stops indexing on the document store once the current indexing batch is finished.

Top

Events

	Name	Description
	AfterAssetAssign	This event is fired after page is assigned. (Inherited from IAssetEvents)
	AfterAssetCheckIn	This event is fired after a page is checked in. (Inherited from IAssetEvents)
	AfterAssetCheckOut	This event is fired after a page is checked out. (Inherited from IAssetEvents)
	AfterAssetCopy	This event is fired after an Asset is copied. (Inherited from IAssetManagerEvents)
	AfterAssetCrossLocaleCopy	This event is fired after an Asset is copied from one Region Root to another. (Inherited from IAssetManagerEvents)
	AfterAssetDelete	This event is fired after an Asset is removed. (Inherited from IAssetManagerEvents)
	AfterAssetMarkForPublishChange	This event is fired after a page had marked-for-publish changes applied to it. (Inherited from IAssetEvents)
	AfterAssetMove	This event is fired after an Asset is moved. (Inherited from IAssetManagerEvents)
	AfterAssetRegionRootCopy	This event is fired after a Region Root is copied. (Inherited from IAssetManagerEvents)
	AfterAssetRemoveFromWorkflow	This event is fired after an asset is removed from a workflow (Inherited from IAssetEvents)
	AfterAssetRollback	This event is fired after a page is rolled back. (Inherited from IAssetEvents)
	AfterAssetUndoCheckOut	This event is fired after a page undo check-out. (Inherited from IAssetEvents)
	AfterCategoryDelete	This event is fired after a Category Node is deleted. (Inherited from ITaxonomyEvents)
	AfterCrossLocaleCopy	This event is fired after a Page is copied across Region Roots. (Inherited from ISiteEvents)
	AfterEmptyAssetRecycleFolder	This event is fired before the asset recycle folder is emptied. (Inherited from IAssetManagerEvents)
	AfterEmptyRecycleFolder	This event is fired after Recycle Folder is emptied. (Inherited from ISiteEvents)
	AfterEntitySave	This event is fired after a Entity object is saved. (Inherited from IEntityEvents)
	AfterPageAssign	This event is fired after page is assigned. (Inherited from IPageEvents)
	AfterPageCheckIn	This event is fired after a page is checked in. (Inherited from IPageEvents)
	AfterPageCheckOut	This event is fired after a page is checked out. (Inherited from IPageEvents)
	AfterPageCopy	This event is fired after a Page is copied. (Inherited from ISiteEvents)
	AfterPageDelete	This event is fired after a Page is removed. (Inherited from ISiteEvents)
	AfterPageMarkForPublishChange	This event is fired after a page had marked-for-publish changes applied to it. (Inherited from IPageEvents)
	AfterPageMove	This event is fired after a Page is moved. (Inherited from ISiteEvents)
	AfterPageRemoveFromWorkflow	This event is fired after a page is removed from a workflow (Inherited from IPageEvents)
	AfterPageRollback	This event is fired after a page is rolled back. (Inherited from IPageEvents)
	AfterPageUndoCheckOut	This event is fired after a page undo check-out. (Inherited from IPageEvents)
	AfterPublishingTargetMarkForPublishChange	This event is fired after any Publishing Target is marked for publish, unmarked for publish, or has its marking version changed. (Inherited from IPublishingTargetEvents)
	AfterRegionRootCopy	This event is fired after a Region Root is copied. (Inherited from ISiteEvents)
	AfterTaxonomyMove	This event is fired after a Category Node is moved. (Inherited from ITaxonomyEvents)
	AfterUserDelete	This event is fired after a User is deleted. (Inherited from IUserEvents)
	AfterUserGroupDelete	This event is fired after a Group is deleted. (Inherited from IUserGroupEvents)
	AfterWorkflowAdvance	Called after all actions are executed and Transition has occured. Not called on a Bridge action. (Inherited from IWorkflowTransitionEvents)
	AfterWorkflowAdvanceAsset	Called after all actions are executed and Transition has occured. Not called on a Bridge action. (Inherited from IWorkflowTransitionEvents)
	AssetCategorizationChanged	This event is fired when a Asset associated, or unassociated with a Category Node. (Inherited from IAssetEvents)
	AssetCheckedInContentUpdated	This event is fired when a Asset was checked with actual text/binary content change (Inherited from IAssetEvents)
	AssetCreated	This event is fired when a new Asset is created. (Inherited from IAssetManagerEvents)
	AssetFileUpdated	This method is invoked after an edit to an Asset File is saved. (Inherited from IAssetManagerEvents)
	AssetPublishStepUpdated	This event is fired when a Publishing Task finishes publishing one Page. (Inherited from IPublishingTaskEvents)
	AssetRenamed	This event is fired after a page is renamed. (Inherited from IAssetEvents)
	BeforeAssetAssign	This event is fired before page is assigned. (Inherited from IAssetEvents)
	BeforeAssetCheckIn	This event is fired before a page is checked in. (Inherited from IAssetEvents)
	BeforeAssetCheckOut	This event is fired before a page is checked out. (Inherited from IAssetEvents)
	BeforeAssetCopy	This event is fired before an Asset to be copied. (Inherited from IAssetManagerEvents)
	BeforeAssetCrossLocaleCopy	This event is fired before an Asset is copied from one Region Root to another. (Inherited from IAssetManagerEvents)
	BeforeAssetDelete	This event is fired before an Asset is moved to Recycle Folder. (Inherited from IAssetManagerEvents)
	BeforeAssetMarkForPublishChange	This event is fired before a page has any changes marked for publish. (Inherited from IAssetEvents)
	BeforeAssetMove	This event is fired before an Asset is moved. (Inherited from IAssetManagerEvents)
	BeforeAssetRegionRootCopy	This event is fired before a Region Root is copied. (Inherited from IAssetManagerEvents)
	BeforeAssetRemoveFromWorkflow	This event is fired before an asset is removed from a workflow (Inherited from IAssetEvents)
	BeforeAssetRollback	This event is fired before a page is rolled back to previous version. (Inherited from IAssetEvents)
	BeforeAssetUndoCheckOut	This event is fired before a page undo check-out. (Inherited from IAssetEvents)
	BeforeCategoryDelete	This event is fired before a Category Node is deleted. (Inherited from ITaxonomyEvents)
	BeforeCrossLocaleCopy	This event is fired before a Page is copied across Region Roots. (Inherited from ISiteEvents)
	BeforeEmptyAssetRecycleFolder	This event is fired before the asset recycle folder is emptied. (Inherited from IAssetManagerEvents)
	BeforeEmptyRecycleFolder	This event is fired before emptying the Recycle Folder. (Inherited from ISiteEvents)
	BeforeEntitySave	This event is fired before any Entity object is about to be saved. (Inherited from IEntityEvents)
	BeforePageAssign	This event is fired before page is assigned. (Inherited from IPageEvents)
	BeforePageCheckIn	This event is fired before a page is checked in. (Inherited from IPageEvents)
	BeforePageCheckOut	This event is fired before a page is checked out. (Inherited from IPageEvents)
	BeforePageCopy	This event is fired before a Page to be copied. (Inherited from ISiteEvents)
	BeforePageDelete	This event is fired before a Page is moved to Recycle Folder. (Inherited from ISiteEvents)
	BeforePageMarkForPublishChange	This event is fired before a page has any changes marked for publish. (Inherited from IPageEvents)
	BeforePageMove	This event is fired before a Page is moved. (Inherited from ISiteEvents)
	BeforePageRemoveFromWorkflow	This event is fired before a page is removed from a workflow (Inherited from IPageEvents)
	BeforePageRollback	This event is fired before a page is rolled back to previous version. (Inherited from IPageEvents)
	BeforePageUndoCheckOut	This event is fired before a page undo check-out. (Inherited from IPageEvents)
	BeforePublish	This event is fired before a Publishing Task is submitted. (Inherited from IPublishingTargetEvents)
	BeforePublishingTargetMarkForPublishChange	This event is fired before any Publishing Target is marked for publish, unmarked for publish, or has its marking version changed. (Inherited from IPublishingTargetEvents)
	BeforeRegionRootCopy	This event is fired before a Region Root is copied. (Inherited from ISiteEvents)
	BeforeTaxonomyMove	This event is fired before a Category Node is moved. (Inherited from ITaxonomyEvents)
	BeforeUserDelete	This event is fired before a User is deleted. (Inherited from IUserEvents)
	BeforeUserGroupDelete	This event is fired before a Group is deleted. (Inherited from IUserGroupEvents)
	BeforeWorkflowAdvance	Called before a Transition occurs. (Inherited from IWorkflowTransitionEvents)
	BeforeWorkflowAdvanceAsset	Called before a Transition occurs. (Inherited from IWorkflowTransitionEvents)
	BeginPublish	This event is fired when a publish starts. (Inherited from IPublishingTaskEvents)
	CategoryCreated	This event is fired when a Category Node is created. (Inherited from ITaxonomyEvents)
	CategoryRenamed	This event is fired when a category is renamed. (Inherited from ICategoryEvents)
	PageCategorizationChanged	This event is fired when a Page associated, or unassociated with a Category Node. (Inherited from IPageEvents)
	PageCreated	This event is fired when a new Page is created. (Inherited from ISiteEvents)
	PageRenamed	This event is fired after a page is renamed. (Inherited from IPageEvents)
	PostProcessContentStepUpdated	This event is fired when a Publishing Content Processor processed one dependency entry (Inherited from IPublishingTaskEvents)
	PublishComplete	This event is fired when a Publishing Task finishes executing. (Inherited from IPublishingTaskEvents)
	Published	This event is fired after a Publishing Task is completed. (Inherited from IPublishingTargetEvents)
	PublishingErrorOccurred	This event is fired when any error occurs during Publishing Task execution. (Inherited from IPublishingTaskEvents)
	PublishStepAdvanced	This event is fired when Publishing Task advances to next step (e.g., when a publish task finishes copying images). (Inherited from IPublishingTaskEvents)
	PublishStepUpdated	This event is fired when a Publishing Task finishes publishing one Page. (Inherited from IPublishingTaskEvents)
	UserCreated	This event is fired when a User is created. (Inherited from IUserEvents)
	UserGroupCreated	This event is fired when a Group is created. (Inherited from IUserGroupEvents)

Top

Remarks

Please refers to Get Started for details of how to retrieve a ContentStore instance from ASP.NET application variables.

Reference

Ingeniux.CMS Namespace

Other Resources

Get Started