Click or drag to resize

ISite Methods

The ISite type exposes the following members.

Methods
  Name Description
Public method Asset Retrieves an Asset by its unique ID.
(Inherited from IAssetManager)
Public method AssetByPath Retrieves an asset by its full path
(Inherited from IAssetManager)
Public method AssetFolder Retrieves a asset folder by its unique ID.
(Inherited from IAssetManager)
Public method AssetFolderByPath Retrieves an asset folder by its full path
(Inherited from IAssetManager)
Public method AssetFolders Retrieves a collection of asset folders by their unique IDs.
(Inherited from IAssetManager)
Public method AssetItem Retrieve an Asset or Asset Folder by its unique ID
(Inherited from IAssetManager)
Public method AssetItems Retrieves a collection of assets by their unique IDs.
(Inherited from IAssetManager)
Public method AssetRegionRoots Retrieves the Asset Items that have Locales set and not Inheriting Locale from their ancestors, in a paginated fashion.
(Inherited from IAssetManager)
Public method AssetRootFolders Retrieves a collection of the Asset Folders at the top level of the asset tree.
(Inherited from IAssetManager)
Public method Code example 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)
Public method Assets(IEnumerableString) Retrieves a collection of Assets by their unique IDs.
(Inherited from IAssetManager)
Public method Assets(Int32, Int32, Int32) Retrieves the collection of all Assets, in a paginated fashion.
(Inherited from IAssetManager)
Public method AssetsAssignedToGroup Retrieves a collection of Assets assigned to a specific Group, in a paginated fashion.
Public method AssetsAssignedToUser Retrieves a collection of Assets assigned to a specific User, in a paginated fashion.
Public method AssetsBySchemas Retrieves assets created using a specified list of asset schemas.
(Inherited from IAssetManager)
Public method AssetsCount Gets the count of Asset on this Site Instance.
Public method 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.
Public method CancelContentFreeze Cancel a pending or ongoing Content Freeze State.
Public method ComponentReferences Retrieves a collection of Pages that have component references to the specified Component, in a paginated fashion.
Public method 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.
Public method ComponentsMetaData  
Public method ContentFreezeState Retrieves the Content Freeze State of the Site Instance. This object is used to toggle content freeze on the Site Instance.
Public method ContentItem  
Public method ContentItems  
Public method ContentItemsAssignedToGroup Gets the Content Items assigned to the specified Group.
Public method ContentItemsAssignedToUserCount Gets the count of Content Items assigned to the specified User.
Public method ContentItemsByKeywords(String, Int32, Boolean, Boolean, Boolean, Boolean, Int32, Int32) Retrieves a collection of Content Items by keywords in the Pages' name, and any text/xhtml field values, in a paginated fashion.
Public method ContentItemsByKeywords(String, String, String, Int32, Boolean, Boolean, Boolean, Boolean, Boolean, Int32, Int32) Retrieves a collection of Content Items 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.
Public method CopyAsset Creates a copy of an Asset into a target Asset Folder.
(Inherited from IAssetManager)
Public method CopyAssetFolder Creates a copy of an Asset Folder in a specified asset folder.
(Inherited from IAssetManager)
Public method CopyAssetItem
(Inherited from IAssetManager)
Public method CopyPage Copies a Page together with its descendants, to the specified location.
Public method CopyPageSingle Copies a Page without its descendants, to the specified location.
Public method CopyRegionRootAssetItem Clones an Asset Item that is set as a region root.
(Inherited from IAssetManager)
Public method 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.
Public method CreateAsset(IAssetFolder, IAssetSchema, String, Boolean, Stream, Boolean) Creates a new Asset with specific Asset Schema.
(Inherited from IAssetManager)
Public method 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)
Public method CreateAssetFolder Creates a new Asset Folder in a specified parent folder.
(Inherited from IAssetManager)
Public method CreateAssetFolderLocaleCache  
Public method CreateAssetLocaleCache  
Public method CreateAssetRootFolder Creates a new Asset Folder at the top level of the asset tree.
(Inherited from IAssetManager)
Public method CreateDITAAlias Creates a new DITA Alias with specific DITA Asset.
Public method CreatePage(IPageCreationRule, String, IPage, Boolean, String) Creates a new Page based on a Page Creation Rule.
Public method CreatePage(ISchema, String, IPage, Boolean, Boolean) Creates a new Page with specific Schema.
Public method CreatePageLocaleCache Fetch and generate a dictionary of page info and parent ids. Used during publish to fetch inherited locales..
Public method CrossLocaleCopyAssetItem

Copies a Asset with language settings, to another location of a new parent Asset Folder with language settings, when there is a Lingual Map established between the Region Roots of both assets.


(Inherited from IAssetManager)
Public method 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.
Public method CurrentVersionFilesCount Calculates the current version files count across all Storage Tracks.
(Inherited from IAssetStorageManager)
Public method DeepCloneT, TManager Duplicates an object instance, not including its unique ID.
(Inherited from ITransactionalEntity)
Public method DITAAlias Retrieves a DITA Alias by its unique Id.
Public method DITAAliases Retrieves a collection of DITA Asset Aliases by their unique Id.
Public method DITAAliasesForAsset Retrieves a collection of DITA Asset Aliases belongs to the specified Asset.
Public method EmptyAssetRecyleFolder Permanently removes all Asset Items in the asset recycle folder.
(Inherited from IAssetManager)
Public method EmptyRecycleFolder Permenantly delete all Pages under Recycle Folder.
Public method FreezeContent Plans a Content Freeze on the Site Instance.
Public method GetEmailTemplate Retrieves the email template for a specific User.
Public method ImagesAssignedToUser Retrieves all image asset that are assigned to user
Public method LinkReferences Retrieves a collection of Pages that have link or link-set references to the specified Target Page , in a paginated fashion.
Public method ManageAssetItemT  
Public method Code example MetaDataReadT Retrieves a meta data value via callback
Public method MoveAsset Moves an asset from its current location to a new target Asset Folder.
(Inherited from IAssetManager)
Public method MoveAssetFolder Moves an Asset Folder together with its descendants to the specified target location.
(Inherited from IAssetManager)
Public method MovePage Moves a Page together with its descendants, to the specified location.
Public method Page Retrieves a Page by its unique Id.
Public method Pages(FuncIPage, Boolean) Retrieves a collection of Pages, filtered by a callback method.
Public method Pages(IEnumerableString) Retrieves a collection of Pages by their unique Ids.
Public method Pages(Int32, Int32, Int32) Retrieves the collection of all Pages, in a paginated fashion.
Public method PagesAssignedToGroup Retrieves a collection of Pages assigned to a specific Group, in a paginated fashion.
Public method PagesAssignedToUser Retrieves a collection of Pages assigned to a specific User, in a paginated fashion.
Public method PagesAssignedToUserCount Gets the count of Pages assigned to the specified User.
Public method PagesByRootNames Retrieves a collection of Pages by their Root Names.
Public method PagesBySchemas Retrieves a collection of Pages by Schemas.
Public method PagesCount Gets the count of Pages on this Site Instance.
Public method 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.
Public method 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.
Public method PagesMetaDataByRootNames  
Public method PreviousVersionsFilesCount Calculated the previous version files count across all Storage Tracks.
(Inherited from IAssetStorageManager)
Public method PreviousVersionsStorageSpace Calculates the total storage space of previous versions across all Storage Tracks.
(Inherited from IAssetStorageManager)
Public method 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)
Public method RecycleAssetFolder Retrieves the Recycle Folder of the AssetManager Instance.
(Inherited from IAssetManager)
Public method RecycleFolder Retrieves the Recycle Folder of the Site Instance
Public method RegionRoots Retrieves the Pages that have Locales set and not Inheriting Locale from their ancestors, in a paginated fashion.
Public method RelatedAssets Retrieves assets that are related to a specified asset.
(Inherited from IAssetManager)
Public method RemoveAsset Removes a single Asset by ID.
(Inherited from IAssetManager)
Public method RemoveAssetFolder Removes a single Asset Folder by ID.
(Inherited from IAssetManager)
Public method RemoveAssetsAndFolders Removes multiple Assets and Asset Folders given an array of asset IDs.
(Inherited from IAssetManager)
Public method RemoveDITAAlias Removes a single Alias.
Public method RemovePage Removes a single Page.
Public method SerializeAssetTree  
Public method SerializeAssetTreeForIncrementalPublishing  
Public method SerializeForIncrementalPublishing(IPublishingTarget, IEnumerableString)  
Public method 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.
Public method SerializeForPublishing(IPublishingTarget)  
Public method 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.
Public method SiteRoot Retrieves the Root Page of the Site Instance.
Public method StorageTrack Retrieves the storage tracking information of an Asset type/schema
(Inherited from IAssetStorageManager)
Public method StorageTracks Retrieves all storage tracks
(Inherited from IAssetStorageManager)
Public method StyleSheets Retrieves the XSLT stylesheets collection in the "App_Data\xml\Stylesheets" Folder.
Public method TotalStorageSpace Calculates the total storage space across all Storage Tracks.
(Inherited from IAssetStorageManager)
Public method UnmanageAssetItemT  
Public method ValidateStylesheets Perform XML validation on the XSLT stylesheets.
Top
See Also