ISchemaManager Interface

Represents the manager object that provides means to query and manage schemas and schema field favorites. It also provides the built-in field definitions.

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

Syntax

C++

Copy

public interface ISchemaManager : ITransactionalEntity, 
	IDisposable

Public Interface ISchemaManager
	Inherits ITransactionalEntity, IDisposable

public interface class ISchemaManager : ITransactionalEntity, 
	IDisposable

type ISchemaManager =  
    interface
        interface ITransactionalEntity
        interface IDisposable
    end

The ISchemaManager 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.)
	FieldDefinitions	Gets the built-in field definitions of schemas and pages. Schemas are constructued from these units.
	Session	Gets the User Session that this manager instance was initiated from. (Inherited from ITransactionalEntity.)
	VersionsLimit	Gets and sets the settings for the number of schema versions the CMS keeps. If the limit is reached, the oldest previous versions of a schema are removed when a new version is saved.

Top

Methods

	Name	Description
	AddFavorite	Adds a new schema field favorite entry to a collection.
	AssetFolderSchema	Gets the schema for asset folders.
	AssetSchema	Retrieves an asset schema with the provided asset type.
	AssetSchemaByExtention	Retrieves the first asset schema found that allows the provided extension.
	AssetSchemaByFriendlyName	Retrieves a asset schema by its friendly name. Friendly names are unique to a schema's collection.
	AssetSchemaById	Retrieves a asset schema by its ID.
	AssetSchemaByRootName	Retrieves a asset schema by its root element name. Root element names are unique to a schema's collection.
	AssetSchemas(String)	Retrieves asset schemas by unique ID.
	AssetSchemas(Int32, Int32, Int32)	Retrieves asset schemas in a paginated fashion.
	AssetSchemasByTypes	Gets a paginated list of Asset Schemas with the provided asset types.
	AssetSchemasCount	Gets the count of all asset schemas, including schemas with errors that cannot be used to create assets.
	CreateAssetSchema	Creates a new asset schema.
	CreateComponentSchema	Creates a new component schema. This schema creates a component page, which doesn't have a fixed view associated with it.
	CreateSchema(String, String, Int32, Boolean, Boolean, String, IPagePresentationCollection, String)	Obsolete. Creates a new Schema. This can be either a page or component schema.
	CreateSchema(String, String, Int32, Boolean, EnumPageSchemaType, String, String, IPagePresentationCollection, String)	Creates a new Schema. This can be either a page or component schema.
	DeepCloneT, TManager	Duplicates an object instance, not including its unique ID. (Inherited from ITransactionalEntity.)
	ExtensionAllowedAssetSchemas	Retrieves a paginated list of asset schemas that allow the provided extension.
	Favorite	Retrieves a schema field favorite entry by it unique ID.
	Favorites	Retrieves all the schema field favorites, in a paginated fashion. These favorites are field combinations used to make schema design more convenient for users.
	HasSchemaFriendlyName	Checks whether a schema with a given friendly name exists in the collection.
	HasSchemaID	Checks whether a schema with a given ID exists in collection.
	ImportAssetSchema	Imports an asset schema with a string serialization of the previous-generation schema XML file.
	ImportSchema(String, Boolean, Boolean)	Imports a schema with a string serialization of the previous-generation schema XML file.
	ImportSchema(XDocument, Boolean, Boolean)	Imports a schema with a string serialization of the previous-generation schema XML file.
	ParseAssetSchema	Parse xml document and convert it into an asset schema entity. Please note that this entity is not saved to database yet.
	ParseSchema	Parse xml document and convert it into a schema entity. Please note that this entity is not saved to database yet.
	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.)
	RemoveAssetSchema	Removes an existing asset schema.
	RemoveFavorite	Removes a schema field favorite entry from a collection by its unique ID.
	RemoveSchema	Removes an existing schema.
	SchemaByFriendlyName	Retrieves a schema by its friendly name. Friendly names are unique to a schema's collection.
	SchemaByID	Retrieves a schema by its ID.
	SchemaByRootName	Retrieves a schema by its page root element name. Root element names are unique to a schema's collection.
	SchemaRootNameAvailable	Checks whether a schema with a given page root element name exists in the collection.
	Schemas(String)	Retrieves schemas by unique ID.
	Schemas(Int32, Int32, Int32)	Retrieves schemas in a paginated fashion.
	SchemasCount	Gets the count of all schemas, including schemas with errors that cannot be used to create pages.
	SystemSchema	Retrieves one of the six system schemas. These system schemas are essential to CMS functionality and cannot be modified via the CSAPI.
	ValidSchemasCount	Gets the count of valid schemas, which can be used to create pages.

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))
{
    ISchemaManager schemasManager = session.SchemasManager;
    ...
}

Examples

There is a metadata XML file from previous-generation CMS content for schema manager; therefore, its output is simply the schema count.

XML

Copy

<Schemas Count="123" />

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSISchema

Ingeniux.CMSISchemaFieldDefinitions

Ingeniux.CMSISchemaFieldFavorite