IAssetSchema Interface

Represents a schema for an Asset. All Assets in the Ingeniux CMS are created from a schema, which defines Asset metadata structure.

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

Syntax

C++

Copy

public interface IAssetSchema : IAssetSchemaBasic, 
	ISchemaCommon, IEntity<ISchemaManager>, IEntity, IEntityEvents, 
	IFileTypeLimitation, ISchemaWithVersions<IAssetSchemaVersion>, ISchemaWithVersions

Public Interface IAssetSchema
	Inherits IAssetSchemaBasic, ISchemaCommon, IEntity(Of ISchemaManager), 
	IEntity, IEntityEvents, IFileTypeLimitation, ISchemaWithVersions(Of IAssetSchemaVersion), 
	ISchemaWithVersions

public interface class IAssetSchema : IAssetSchemaBasic, 
	ISchemaCommon, IEntity<ISchemaManager^>, IEntity, IEntityEvents, 
	IFileTypeLimitation, ISchemaWithVersions<IAssetSchemaVersion^>, ISchemaWithVersions

type IAssetSchema =  
    interface
        interface IAssetSchemaBasic
        interface ISchemaCommon
        interface IEntity<ISchemaManager>
        interface IEntity
        interface IEntityEvents
        interface IFileTypeLimitation
        interface ISchemaWithVersions<IAssetSchemaVersion>
        interface ISchemaWithVersions
    end

The IAssetSchema type exposes the following members.

Properties

	Name	Description
	AllowedExtensions	Gets/sets the allowed extensions (Inherited from IFileTypeLimitation.)
	Archived	Gets the archived value of this entity (Inherited from IEntity.)
	Created	Gets the entity's creation date. (Inherited from IEntity.)
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity.)
	CurrentVersion	(Inherited from ISchemaWithVersionsT.)
	CurrentVersionNumber	(Inherited from ISchemaWithVersions.)
	Drafting	Gets whether the schema is in drafting state. When a schema is in drafting state, it cannot be used for page creation. (Inherited from ISchemaCommon.)
	FriendlyName	Gets and sets the schema's friendly name. (Inherited from ISchemaCommon.)
	Icon	Gets and sets the icon of the page to be created with this schema. (Inherited from ISchemaCommon.)
	LastModified	Gets the date when the entity was most recently modified. (Inherited from IEntity.)
	LastModifiedUser	Gets the ID of the User who lasted edited the entity. (Inherited from IEntity.)
	Manager	Gets the manager that retrieved this entity instance. (Inherited from IEntityTManager.)
	Name	Gets and sets the entity's name. (Inherited from IEntity.)
	RootName	Gets and sets the name of the schema's root element. (Inherited from ISchemaCommon.)
	SchemaSystemSecurity	(Inherited from ISchemaWithVersions.)
	Session	Gets the session that retrieved this entity. An entity is always session-specific. (Inherited from IEntity.)
	SessionId	Gets the unique ID of the session that retrieved this entity. (Inherited from IEntity.)
	StorageQuota	Gets the storage limitation associated with the Asset type defined by this schema (Inherited from IAssetSchemaBasic.)
	ThumbnailRelativePath	Gets and sets the thumbnail image path of the schema to be associated with this schema. (Inherited from ISchemaWithVersions.)
	Type	Gets/sets the type of Asset
	Versioning	(Inherited from ISchemaCommon.)
	WorkflowDefinition	Gets and sets the workflow defintion for this schema. If set, pages created with this schema will be added to a workflow based on this defintion right away. (Inherited from ISchemaCommon.)
	WorkflowRequired	Gets and sets whether pages created via this schema are added to a workflow after creation. If this property is set to true, the WorkflowDefinition property must be set to a valid workflow definition. Otherwise, validation will fail. (Inherited from ISchemaCommon.)

Top

Methods

	Name	Description
	AddAllowedRootCategory	Adds a new root category to the allowed root categories collection. (Inherited from ISchemaCommon.)
	AddDefaultCategory	Adds a new default category. (Inherited from ISchemaCommon.)
	AddField	Adds a new schema field to the collection, either at the specified position or at the end. (Inherited from ISchemaCommon.)
	AllowedCategoryRoots	Retrieves the collection of categories. Categories and their descendants in this collection are allowed to be associated with pages created with this schema. (Inherited from ISchemaCommon.)
	AllowedCategoryRootsCount	Gets the count of allowed root categories. (Inherited from ISchemaCommon.)
	AllowFileType	Finds out whether the specific file name is allowed for this Asset type (Inherited from IFileTypeLimitation.)
	ClearAllowedCategoryRoots	Clears all allowed root categories. (Inherited from ISchemaCommon.)
	ClearDefaultCategories	Clear all default categories. (Inherited from ISchemaCommon.)
	ClearFields	Clears all Fields from the collection. (Inherited from ISchemaCommon.)
	DefaultCategories	Retrieves the default categories collection for pages created with this schema. When page is created, these categories are automaticaly applied to the page. (Inherited from ISchemaCommon.)
	DefaultCategoriesCount	Gets the count of default categories. (Inherited from ISchemaCommon.)
	Field(Int32)	Retrieves a schema field by its positional index. (Inherited from ISchemaCommon.)
	Field(String)	Retrieves a schema field by its name. (Inherited from ISchemaCommon.)
	Fields	Gets the collection of fields in this schema. (Inherited from ISchemaCommon.)
	FieldsCount	Gets the count of fields in this schema. (Inherited from ISchemaCommon.)
	IsSystemSchema	Checks whether this Schema is an essential schema that comes with default CMS instance. (Inherited from ISchemaWithVersionsT.)
	RemoveAllowedRootCategory	Removes a category from the the allowed root categories collection. (Inherited from ISchemaCommon.)
	RemoveDefaultCategory	Removes a default category. (Inherited from ISchemaCommon.)
	RemoveField	Removes from the collection a schema field at a specified index. (Inherited from ISchemaCommon.)
	Save	Saves this schema. (Inherited from ISchemaWithVersions.)
	SetThumbnail	(Inherited from ISchemaWithVersions.)
	Touch	Updated the entity's LastModified value to the current time. (Inherited from IEntity.)
	UpdateContent	Updates the schema with provided XML content and saves the schema in draft mode. If new content doesn't have a matching root name and friendly name, it will not be accepted. (Inherited from ISchemaWithVersions.)
	ValidateData	Validates this entity's data. Implemented by concrete inheriting types. (Inherited from IEntity.)
	ValidateUserPermission	Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity. (Inherited from IEntity.)
	Version	(Inherited from ISchemaWithVersionsT.)
	Versions	(Inherited from ISchemaWithVersionsT.)
	VersionsCount	(Inherited from ISchemaWithVersions.)

Top

Events

	Name	Description
	AfterEntitySave	This event is fired after a Entity object is saved. (Inherited from IEntityEvents.)
	BeforeEntitySave	This event is fired before any Entity object is about to be saved. (Inherited from IEntityEvents.)

Top

Reference

Ingeniux.CMS Namespace