ISite Interface

Ingeniux CMS Content Store API

Represents the manager object that provides the means to query and manage Pages and Page Versions.

It is the most important manager, due to fact it manages the central pieces of CMS, the Pages.

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

Syntax

public interface ISite : ITransactionalEntity, IDisposable, 
	IContentStoreMetaData, ISiteEvents

Public Interface ISite
	Inherits ITransactionalEntity, IDisposable, IContentStoreMetaData, ISiteEvents

public interface class ISite : ITransactionalEntity, 
	IDisposable, IContentStoreMetaData, ISiteEvents

type ISite =  
    interface
        interface ITransactionalEntity
        interface IDisposable
        interface IContentStoreMetaData
        interface ISiteEvents
    end

The ISite type exposes the following members.

Properties

	Name	Description
	ContentStore	Gets the Content Store. (Inherited from ITransactionalEntity.)
	CurrentUser	Gets the Operating User for the Session . (Inherited from ITransactionalEntity.)
	GlobalExportsUpdated	Gets the time of the most recent global exports update. (Inherited from IContentStoreMetaData.)
	HttpsOn	Gets and sets whether HTTPS is enabled. (Inherited from IContentStoreMetaData.)
	MediaHost	Gets and sets the MediaHost, which is the computer that hosts the images folder. (Inherited from IContentStoreMetaData.)
	MediaHostModule	Gets and sets the MediaHostModule, which is the module on the MediaHost to which files are copied. (Inherited from IContentStoreMetaData.)
	PublishingTargetsUpdated	Gets the time of the most recent publishing targets update. (Inherited from IContentStoreMetaData.)
	RedirectsUpdated	Gets the time of the most recent redirect update. (Inherited from IContentStoreMetaData.)
	ReferenceMappingUpdated	Gets the time of most recent references mapping update. (Inherited from IContentStoreMetaData.)
	ServerName	Gets and sets the ServerName, which is the value returned from the ServerVariable SERVER_NAME. (Inherited from IContentStoreMetaData.)
	ServerPort	Gets and sets the server port. (Inherited from IContentStoreMetaData.)
	Session	Gets the User Session that this manager instance was initiated from. (Inherited from ITransactionalEntity.)
	Settings	Gets the Common CMS settings
	SiteUrl	Gets and sets the URL of the Site. (Inherited from IContentStoreMetaData.)
	SiteVersion	Gets the Version information of the Site Instance. It is the version of the site's assemblies in "bin" folder.
	TaxonomyAssociationsUpdated	Gets the time of the most recent taxonomy associations update. (Inherited from IContentStoreMetaData.)
	VersionsLimit	Gets/sets the limit of Page Versions to be kept on each Page. Older Page Versions are automatically removed from Content Store if this settings is set.
	XmlDirectoryPath	Gets the full path of "App_Data/xml" folder of the Site Instance

Top

Methods

	Name	Description
	CancelContentFreeze	Cancel a pending or ongoing Content Freeze State.
	ComponentReferences	Retrieves a collection of Pages that have component references to the specified Component, in a paginated fashion.
	Components	Retrieves the collection of all Component Pages, in a paginated fashion. Components don't have their own view/template. They are shared among Pages as reusable content.
	ComponentsMetaData
	ContentFreezeState	Retrieves the Content Freeze State of the Site Instance. This object is used to toggle content freeze on the Site Instance.
	CopyPage	Copies a Page together with its descendants, to the specified location.
	CopyRegionRootPage	Clones a Region Root, together with its descendants, to another location. The cloned Page will also be a Region Root, with the specified language setting applied. This method will create a collection of Lingual Maps from the source Page and its descendants, to their corresponding clone Pages.
	CreatePage(IPageCreationRule, String, IPage, Boolean, String)	Creates a new Page based on a Page Creation Rule.
	CreatePage(ISchema, String, IPage, Boolean, Boolean)	Creates a new Page with specific Schema.
	CrossLocaleCopyPage	Copies a Page with language settings, together with its descendants, to another location of a Page with language settings, when there is a Lingual Map established between the Region Roots of both Pages . This method will create a collection of Lingual Maps from the source Page and its descendants, to their corresponding clone Pages.
	DeepCloneT, TManager	Duplicates an object instance, not including its unique ID. (Inherited from ITransactionalEntity.)
	EmptyRecycleFolder	Permenantly delete all Pages under Recycle Folder.
	FreezeContent	Plans a Content Freeze on the Site Instance.
	GetEmailTemplate	Retrieves the email template for a specific User.
	LinkReferences	Retrieves a collection of Pages that have link or link-set references to the specified Target Page , in a paginated fashion.
	MetaDataReadT	Retrieves a meta data value via callback
	MovePage	Moves a Page together with its descendants, to the specified location.
	Page	Retrieves a Page by its unique Id.
	Pages(IEnumerableString)	Retrieves a collection of Pages by their unique Ids.
	Pages(FuncIPage, Boolean)	Retrieves a collection of Pages, filtered by a callback method.
	Pages(Int32, Int32, Int32)	Retrieves the collection of all Pages, in a paginated fashion.
	PagesAssignedToUser	Retrieves a collection of Pages assigned to a specific User, in a paginated fashion.
	PagesAssignedToUserCount	Gets the count of Pages assigned to the specified User.
	PagesByKeywords(String, Int32, Boolean, Boolean, Int32, Int32)	Retrieves a collection of Pages by keywords in the Pages' Name, and any text/xhtml field values, in a paginated fashion.
	PagesByKeywords(String, String, String, Int32, Boolean, Boolean, Boolean, Int32, Int32)	Retrieves a collection of Pages by keywords in the Pages' Name, or specified text/xhtml field, with additional filtering of Root Name and field to search on, in a paginated fashion.
	PagesByRootNames	Retrieves a collection of Pages by their Root Names.
	PagesBySchemas	Retrieves a collection of Pages by Schemas.
	PagesCount	Gets the count of Pages on this Site Instance.
	PagesHistoryByKeywords(String, Int32, Boolean, Int32, Int32)	Retrieves a collection of Page Versions by keywords in the Pages' Name, and any text/xhtml field values, in a paginated fashion. This search covers the entire existing history of the Pages.
	PagesHistoryByKeywords(String, String, String, Int32, Boolean, Boolean, Int32, Int32)	Retrieves a collection of Page Versions by keywords in the Pages' Name, or specified text/xhtml field, with additional filtering of Root Name and field to search on, in a paginated fashion.
	PagesMetaDataByRootNames
	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.)
	RecycleFolder	Retrieves the Recycle Folder of the Site Instance
	RegionRoots	Retrieves the Pages that have Locales set and not Inheriting Locale from their ancestors, in a paginated fashion.
	RemovePage	Removes a single Page.
	SerializeForIncrementalPublishing	Incrementally produces XML serialization for a specific Publishing Target. This method generates the content of published reference.xml for Dynamic Site Server.
	SerializeForPublishing	Produces XML serialization for a specific Publishing Target. This method generates the content of published reference.xml for Dynamic Site Server.
	SiteRoot	Retrieves the Root Page of the Site Instance.
	StyleSheets	Retrieves the XSLT stylesheets collection in the "App_Data\xml\Stylesheets" Folder.
	ValidateStylesheets	Perform XML validation on the XSLT stylesheets.

Top

Events

	Name	Description
	AfterCrossLocaleCopy	This event is fired after a Page is copied across Region Roots. (Inherited from ISiteEvents.)
	AfterEmptyRecycleFolder	This event is fired after Recycle Folder is emptied. (Inherited from ISiteEvents.)
	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.)
	AfterPageMove	This event is fired after a Page is moved. (Inherited from ISiteEvents.)
	AfterRegionRootCopy	This event is fired after a Region Root is copied. (Inherited from ISiteEvents.)
	BeforeCrossLocaleCopy	This event is fired before a Page is copied across Region Roots. (Inherited from ISiteEvents.)
	BeforeEmptyRecycleFolder	This event is fired before emptying the Recycle Folder. (Inherited from ISiteEvents.)
	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.)
	BeforePageMove	This event is fired before a Page is moved. (Inherited from ISiteEvents.)
	BeforeRegionRootCopy	This event is fired before a Region Root is copied. (Inherited from ISiteEvents.)
	PageCreated	This event is fired when a new Page is created. (Inherited from ISiteEvents.)

Top

Remarks

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

Copy

using (IUserSession session = store.OpenReadSession(currentUser))
{
       ISite site = session.Site;
       ...
}

Unlike the Site object before version 9.0, DO NOT store instance of this object in ASP.NET session.

Examples

Serialization of Site matches the serialization of reference.xml in previous-generation CMS content:

Copy

<?xml version="1.0" encoding="utf-8"?>
<Site ID="x1" Name="Content Store" CheckedOut="false" SCID="Schema_Folder" SCV="1" AssignedUser="" AssignedGroup="" Schema="Folder" PageType="0" Locale="" LocaleInherited="true" Created="20140529T15:16:00" CreatedBy="ingeniux\ashley" Changed="20140625T09:53:15" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" SiteBaseUrl="" xmlns="x-schema:siteSchema.xml">
  <Page ID="x3" Name="Site" CheckedOut="false" SCID="Schema_Folder" SCV="1" AssignedUser="" AssignedGroup="" Schema="Folder" PageType="1" Locale="" LocaleInherited="true" Created="20140529T16:11:45" CreatedBy="ingeniux\ashley" Changed="20140625T09:53:15" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59">
    <Page ID="x2" Name="Home" CheckedOut="true" SCID="schemas/23" SCV="5" AssignedUser="ingeniux\awang" AssignedGroup="" Schema="Home" PageType="7" Locale="" LocaleInherited="true" Created="20140529T16:03:08" CreatedBy="ingeniux\ashley" Changed="20140710T09:42:16" LastChangedBy="ingeniux\awang" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59">
      <Page ID="x34" Name="Products" CheckedOut="false" SCID="schemas/28" SCV="6" AssignedUser="" AssignedGroup="" Schema="ProductFront" PageType="8" Locale="" LocaleInherited="true" Created="20140602T15:50:27" CreatedBy="ingeniux\ashley" Changed="20140619T16:52:37" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59">
        <Page ID="x43" Name="Cartella" CheckedOut="false" SCID="schemas/27" SCV="6" AssignedUser="" AssignedGroup="" Schema="ProductDetail" PageType="8" Locale="" LocaleInherited="true" Created="20140603T14:46:10" CreatedBy="ingeniux\ashley" Changed="20140612T11:22:29" LastChangedBy="ingeniux\admin1" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" />
        <Page ID="x44" Name="CMS" CheckedOut="false" SCID="schemas/27" SCV="6" AssignedUser="" AssignedGroup="" Schema="ProductDetail" PageType="8" Locale="" LocaleInherited="true" Created="20140603T15:02:29" CreatedBy="ingeniux\ashley" Changed="20140612T11:22:29" LastChangedBy="ingeniux\admin1" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" />
      </Page>
      <Page ID="x41" Name="Solutions" CheckedOut="false" SCID="schemas/31" SCV="3" AssignedUser="" AssignedGroup="" Schema="SolutionsFront" PageType="8" Locale="" LocaleInherited="true" Created="20140603T14:21:21" CreatedBy="ingeniux\ashley" Changed="20140603T16:14:55" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59">
        <Page ID="x47" Name="Mainstream" CheckedOut="false" SCID="schemas/30" SCV="3" AssignedUser="" AssignedGroup="" Schema="SolutionsDetail" PageType="8" Locale="" LocaleInherited="true" Created="20140603T15:42:05" CreatedBy="ingeniux\ashley" Changed="20140603T16:14:55" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" />
        <Page ID="x48" Name="Information Technology" CheckedOut="false" SCID="schemas/30" SCV="3" AssignedUser="ingeniux\ashley" AssignedGroup="" Schema="SolutionsDetail" PageType="8" Locale="" LocaleInherited="true" Created="20140603T15:44:43" CreatedBy="ingeniux\ashley" Changed="20140616T16:55:16" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" />
        <Page ID="x49" Name="Higher Education" CheckedOut="false" SCID="schemas/30" SCV="3" AssignedUser="" AssignedGroup="" Schema="SolutionsDetail" PageType="8" Locale="" LocaleInherited="true" Created="20140603T15:44:44" CreatedBy="ingeniux\ashley" Changed="20140603T16:14:55" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" />
        <Page ID="x50" Name="E-commerce" CheckedOut="false" SCID="schemas/30" SCV="3" AssignedUser="" AssignedGroup="" Schema="SolutionsDetail" PageType="8" Locale="" LocaleInherited="true" Created="20140603T15:44:46" CreatedBy="ingeniux\ashley" Changed="20140603T16:14:55" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" />
        <Page ID="x51" Name="Intranets and Extranets" CheckedOut="false" SCID="schemas/30" SCV="3" AssignedUser="" AssignedGroup="" Schema="SolutionsDetail" PageType="8" Locale="" LocaleInherited="true" Created="20140603T15:44:48" CreatedBy="ingeniux\ashley" Changed="20140603T16:14:55" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" />
        <Page ID="x52" Name="Structured Pyramids" CheckedOut="false" SCID="schemas/30" SCV="3" AssignedUser="" AssignedGroup="" Schema="SolutionsDetail" PageType="8" Locale="" LocaleInherited="true" Created="20140603T15:44:53" CreatedBy="ingeniux\ashley" Changed="20140603T16:14:55" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" />
      </Page>
    </Page>
  </Page>
  <Page ID="RecycleBin" Name="Recycle Folder" CheckedOut="false" SCID="Schema_Folder" SCV="1" AssignedUser="" AssignedGroup="" Schema="Folder" PageType="1" Locale="" LocaleInherited="true" Created="20140529T15:16:01" CreatedBy="ingeniux\ashley" Changed="20140701T21:16:14" LastChangedBy="ingeniux\ashley" StartDate="00010101T00:00:00" EndDate="99991231T23:59:59" />
</Site>

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSIPage

Ingeniux.CMSIPageVersion

Ingeniux.CMSISettings