IAssetManager Interface

Represents the manager object that provide means to query and manage Assets and Asset Folders.

Remarks

This interface is inherited by ISite interface.

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;
    ...
}

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

Syntax

C++

Copy

public interface IAssetManager : ITransactionalEntity, 
	IDisposable, IAssetManagerEvents, IAssetStorageManager

Public Interface IAssetManager
	Inherits ITransactionalEntity, IDisposable, IAssetManagerEvents, IAssetStorageManager

public interface class IAssetManager : ITransactionalEntity, 
	IDisposable, IAssetManagerEvents, IAssetStorageManager

type IAssetManager = 
    interface
        interface ITransactionalEntity
        interface IDisposable
        interface IAssetManagerEvents
        interface IAssetStorageManager
    end

The IAssetManager 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)
	Session	Gets the User Session that this manager instance was initiated from. (Inherited from ITransactionalEntity)

Top

Methods

	Name	Description
	Asset	Retrieves an Asset by its unique ID.
	AssetByPath	Retrieves an asset by its full path
	AssetFolder	Retrieves a asset folder by its unique ID.
	AssetFolderByPath	Retrieves an asset folder by its full path
	AssetFolders	Retrieves a collection of asset folders by their unique IDs.
	AssetItem	Retrieve an Asset or Asset Folder by its unique ID
	AssetItems	Retrieves a collection of assets by their unique IDs.
	AssetRegionRoots	Retrieves the Asset Items that have Locales set and not Inheriting Locale from their ancestors, in a paginated fashion.
	AssetRootFolders	Retrieves a collection of the Asset Folders at the top level of the asset tree.
	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.
	Assets(IEnumerableString)	Retrieves a collection of Assets by their unique IDs.
	Assets(Int32, Int32, Int32)	Retrieves the collection of all Assets, in a paginated fashion.
	AssetsBySchemas	Retrieves assets created using a specified list of asset schemas.
	CopyAsset	Creates a copy of an Asset into a target Asset Folder.
	CopyAssetFolder	Creates a copy of an Asset Folder in a specified asset folder.
	CopyAssetItem
	CopyRegionRootAssetItem	Clones an Asset Item that is set as a region root.
	CreateAsset(IAssetFolder, IAssetSchema, String, Boolean, Stream, Boolean)	Creates a new Asset with specific Asset Schema.
	CreateAsset(IAssetFolder, IAssetSchema, String, Boolean, String, Boolean)	Creates a new Asset with specific Asset Schema with an external URL rather than an uploaded file.
	CreateAssetFolder	Creates a new Asset Folder in a specified parent folder.
	CreateAssetRootFolder	Creates a new Asset Folder at the top level of the asset tree.
	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.
	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.
	MoveAsset	Moves an asset from its current location to a new target Asset Folder.
	MoveAssetFolder	Moves an Asset Folder together with its descendants to the specified target location.
	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.
	RelatedAssets	Retrieves assets that are related to a specified asset.
	RemoveAsset	Removes a single Asset by ID.
	RemoveAssetFolder	Removes a single Asset Folder by ID.
	RemoveAssetsAndFolders	Removes multiple Assets and Asset Folders given an array of asset IDs.
	StorageTrack	Retrieves the storage tracking information of an Asset type/schema (Inherited from IAssetStorageManager)
	StorageTracks	Retrieves all storage tracks (Inherited from IAssetStorageManager)
	TotalStorageSpace	Calculates the total storage space across all Storage Tracks. (Inherited from IAssetStorageManager)

Top

Events

	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)
	AfterEmptyAssetRecycleFolder	This event is fired before the asset recycle folder is emptied. (Inherited from IAssetManagerEvents)
	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)
	BeforeEmptyAssetRecycleFolder	This event is fired before the asset recycle folder is emptied. (Inherited from IAssetManagerEvents)

Top

Reference

Ingeniux.CMS Namespace

IAsset

IAssetFolder

ISite