ISite Interface

public interface ISite : ITransactionalEntity, IDisposable, 
	IContentStoreMetaData, ISiteEvents, IAssetManager, IAssetManagerEvents, IAssetStorageManager

Public Interface ISite
	Inherits ITransactionalEntity, IDisposable, IContentStoreMetaData, ISiteEvents, 
	IAssetManager, IAssetManagerEvents, IAssetStorageManager

public interface class ISite : ITransactionalEntity, 
	IDisposable, IContentStoreMetaData, ISiteEvents, IAssetManager, IAssetManagerEvents, 
	IAssetStorageManager

type ISite =  
    interface
        interface ITransactionalEntity
        interface IDisposable
        interface IContentStoreMetaData
        interface ISiteEvents
        interface IAssetManager
        interface IAssetManagerEvents
        interface IAssetStorageManager
    end

	Name	Description
	AssetTreeMenuConfig
	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

	Name	Description
	Asset	Retrieves an Asset by its unique ID. (Inherited from IAssetManager.)
	AssetByPath	Retrieves an asset by its full path (Inherited from IAssetManager.)
	AssetFolder	Retrieves a asset folder by its unique ID. (Inherited from IAssetManager.)
	AssetFolderByPath	Retrieves an asset folder by its full path (Inherited from IAssetManager.)
	AssetFolders	Retrieves a collection of asset folders by their unique IDs. (Inherited from IAssetManager.)
	AssetItem	Retrieve an Asset or Asset Folder by its unique ID (Inherited from IAssetManager.)
	AssetItems	Retrieves a collection of assets by their unique IDs. (Inherited from IAssetManager.)
	AssetRegionRoots	Retrieves the Asset Items that have Locales set and not Inheriting Locale from their ancestors, in a paginated fashion. (Inherited from IAssetManager.)
	AssetRootFolders	Retrieves a collection of the Asset Folders at the top level of the asset tree. (Inherited from IAssetManager.)
	Assets(IEnumerableString)	Retrieves a collection of Assets by their unique IDs. (Inherited from IAssetManager.)
	Assets(FuncIAsset, Boolean)	Retrieves a collection of Assets, pre-filtered through a function. e.g. a function to filter assets that have the jpg extension. (Inherited from IAssetManager.)
	Assets(Int32, Int32, Int32)	Retrieves the collection of all Assets, in a paginated fashion. (Inherited from IAssetManager.)
	AssetsBySchemas	Retrieves assets created using a specified list of asset schemas. (Inherited from IAssetManager.)
	AssetsCount	Gets the count of Asset on this Site Instance.
	CacheAssetFolderPaths	Fetch and generate a dictionary of asset folder names and parent ids. Used during publish to allow asset.path() to pull from this cache.
	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.
	ContentItem
	ContentItems
	ContentItemsByKeywords(String, Int32, Boolean, Boolean, 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.
	ContentItemsByKeywords(String, String, String, Int32, Boolean, Boolean, 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.
	CopyAsset	Creates a copy of an Asset into a target Asset Folder. (Inherited from IAssetManager.)
	CopyAssetFolder	Creates a copy of an Asset Folder in a specified asset folder. (Inherited from IAssetManager.)
	CopyPage	Copies a Page together with its descendants, to the specified location.
	CopyPageSingle	Copies a Page without its descendants, to the specified location.
	CopyRegionRootAssetItem	Clones an Asset Item that is set as a region root. (Inherited from IAssetManager.)
	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.
	CreateAsset(IAssetFolder, IAssetSchema, String, Boolean, Stream, Boolean)	Creates a new Asset with specific Asset Schema. (Inherited from IAssetManager.)
	CreateAsset(IAssetFolder, IAssetSchema, String, Boolean, String, Boolean)	Creates a new Asset with specific Asset Schema with an external URL rather than an uploaded file. (Inherited from IAssetManager.)
	CreateAssetFolder	Creates a new Asset Folder in a specified parent folder. (Inherited from IAssetManager.)
	CreateAssetFolderLocaleCache
	CreateAssetLocaleCache
	CreateAssetRootFolder	Creates a new Asset Folder at the top level of the asset tree. (Inherited from IAssetManager.)
	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.
	CreatePageLocaleCache	Fetch and generate a dictionary of page info and parent ids. Used during publish to fetch inherited locales..
	CrossLocaleCopyAssetItem	(Inherited from IAssetManager.)
	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.
	CurrentVersionFilesCount	Calculates the current version files count across all Storage Tracks. (Inherited from IAssetStorageManager.)
	DeepCloneT, TManager	Duplicates an object instance, not including its unique ID. (Inherited from ITransactionalEntity.)
	EmptyAssetRecyleFolder	Permanently removes all Asset Items in the asset recycle folder. (Inherited from IAssetManager.)
	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.
	ImagesAssignedToUser	Retrieves all image asset that are assigned to user
	LinkReferences	Retrieves a collection of Pages that have link or link-set references to the specified Target Page , in a paginated fashion.
	ManageAssetItemT
	MetaDataReadT	Retrieves a meta data value via callback
	MoveAsset	Moves an asset from its current location to a new target Asset Folder. (Inherited from IAssetManager.)
	MoveAssetFolder	Moves an Asset Folder together with its descendants to the specified target location. (Inherited from IAssetManager.)
	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.
	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
	PreviousVersionsFilesCount	Calculated the previous version files count across all Storage Tracks. (Inherited from IAssetStorageManager.)
	PreviousVersionsStorageSpace	Calculates the total storage space of previous versions across all Storage Tracks. (Inherited from IAssetStorageManager.)
	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.)
	RecycleAssetFolder	Retrieves the Recycle Folder of the AssetManager Instance. (Inherited from IAssetManager.)
	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.
	RelatedAssets	Retrieves assets that are related to a specified asset. (Inherited from IAssetManager.)
	RemoveAsset	Removes a single Asset by ID. (Inherited from IAssetManager.)
	RemoveAssetFolder	Removes a single Asset Folder by ID. (Inherited from IAssetManager.)
	RemovePage	Removes a single Page.
	SerializeAssetTree
	SerializeAssetTreeForIncrementalPublishing
	SerializeForIncrementalPublishing(IPublishingTarget, IEnumerableString)
	SerializeForIncrementalPublishing(IPublishingTarget, IEnumerableString, DictionaryString, IPage)	Incrementally produces XML serialization for a specific Publishing Target. This method generates the content of published reference.xml for Dynamic Site Server.
	SerializeForPublishing(IPublishingTarget)
	SerializeForPublishing(IPublishingTarget, DictionaryString, IPage)	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.
	StorageTrack	Retrieves the storage tracking information of an Asset type/schema (Inherited from IAssetStorageManager.)
	StorageTracks	Retrieves all storage tracks (Inherited from IAssetStorageManager.)
	StyleSheets	Retrieves the XSLT stylesheets collection in the "App_Data\xml\Stylesheets" Folder.
	TotalStorageSpace	Calculates the total storage space across all Storage Tracks. (Inherited from IAssetStorageManager.)
	UnmanageAssetItemT
	ValidateStylesheets	Perform XML validation on the XSLT stylesheets.

Top

	Name	Description
	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.)
	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.)
	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.)
	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.)
	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.)
	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.)
	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.)
	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.)
	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

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

C#

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.

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

XML

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.CMSIAsset

Ingeniux.CMSIAssetVersion

Ingeniux.CMSISettings