Ingeniux CMS Content Store API
Ingeniux.CMS
AssetType Enumeration
ChoicesProviderApplicableCondition Class
ChoicesProviderOptions Class
ContentStore Class
CSSType Enumeration
IAction Interface
IActionTypeAttribute Interface
IArchiver Interface
IAsset Interface
IAssetAdminContentDirect Interface
IAssetElement Interface
IAssetEvents Interface
IAssetFolder Interface
IAssetFolderSchema Interface
IAssetItem Interface
IAssetManager Interface
IAssetManagerEvents Interface
IAssetMap Interface
IAssetMapEntry Interface
IAssetNodeLevelPermission Interface
IAssetPathHistoryEntry Interface
IAssetPublisher Interface
IAssetRelations Interface
IAssetSchema Interface
IAssetSchemaBasic Interface
IAssetSchemaVersion Interface
IAssetSecurityEntry Interface
IAssetSecurityManager Interface
IAssetStorageManager Interface
IAssetStorageTrack Interface
IAssetVersion Interface
IAttribute Interface
IAudioTechnicalMetadata Interface
IAudit_Entity Interface
IAudit_User Interface
IAuditEntry Interface
IAuditTrail Interface
IAuditTrailSettings Interface
IAWSReplicationTarget Interface
IAzureStorageReplicationTarget Interface
IBlockedGroupsSecurityCollection<TManager> Interface
IBrandEntryBase Interface
ICategoryEvents Interface
ICategoryNode Interface
ICategorySynonym Interface
ICategoryTranslation Interface
IComponentElement Interface
IContentFreezeState Interface
IContentItem Interface
IContentItem<T, TVersion, TSchema, TSchemaVersion> Interface
IContentItemMarking Interface
IContentItemPublishStep Interface
IContentItemVersion Interface
IContentItemVersion<TSchema, TSchemaVersion> Interface
IContentItemWorkflowSuper Interface
IContentStore Interface
IContentStoreEvents Interface
IContentStoreMetaData Interface
ICSSTechnicalMetadata Interface
ICustomLocale Interface
ICustomTabsConfig Interface
ICustomTabSetting Interface
ICustomWorkflowAction Interface
IDashboardPreferences Interface
IDescriptiveMetadata Interface
IDevice Interface
IDeviceBundle Interface
IElement Interface
IEmailer Interface
IEntity Interface
IEntity<TManager> Interface
IEntityEvents Interface
IEnumerationElementChoicesProvider Interface
IExportDefinition Interface
IExportElement Interface
IExportsElement Interface
IFileReplicationItem Interface
IFileReplicationTarget Interface
IFileTypeLimitation Interface
IFinalizeCloneInfo Interface
IFTPReplicationTarget Interface
IFTPSReplicationTarget Interface
IGenericDevice Interface
IGlobalExportEntries Interface
IGlobalExports Interface
IGlobalVariable Interface
IGlobalVariablesCollection Interface
IGroupElement Interface
IGroupRole Interface
IGX_Dashboard_Options Enumeration
IHierarchyId Interface
IImageTechnicalMetadata Interface
IIndexableEntityBuilder Interface
IInstanceLogger Interface
IJsonTechnicalMetadata Interface
ILanguageSpecificMetaData Interface
ILingualMappingManager Interface
ILingualPageMap Interface
ILingualPageVersionMap Interface
ILinkElement Interface
IListElement Interface
IListStep Interface
ILocale Interface
ILocalesManager Interface
ILocaleSpecific Interface
ILoggingManager Interface
IManagersHost Interface
IMobileDeviceManager Interface
IMultiEntryMetadata Interface
INavigationElement Interface
IndexableEntityBuilder Class
IndexableEntityBuilderSettings Class
INodeLevelPermission Interface
INotification Interface
INotificationManager Interface
IPage Interface
IPageContent Interface
IPageCreationRule Interface
IPageCreationRuleEntryForPage Interface
IPageCreationRulesManager Interface
IPageEvents Interface
IPageVersion Interface
IPathHistoryEntry Interface
IPathMap Interface
IPathMapEntry Interface
IPathMapEntry<THistory> Interface
IPcrOverridesDocument Interface
IPCRParentPage Interface
IPresentationSystemSecurity Interface
IPublishError Interface
IPublishingManager Interface
IPublishingPageEntry Interface
IPublishingProfile Interface
IPublishingSystemSecurity Interface
IPublishingTarget Interface
IPublishingTargetEvents Interface
IPublishingTargetVariable Interface
IPublishingTask Interface
IPublishingTaskEvents Interface
IPublishLog Interface
IPublishLogSummary Interface
IPublishTaskMonitor Interface
IReadonlyUser Interface
IRedirect Interface
IReferenceEntry Interface
IReferencesManager Interface
IReplicationAdditionalLocation Interface
IReplicationCleanupExemption Interface
IReplicationExemption Interface
IReplicationItem Interface
IReplicationLog Interface
IReplicationTarget Interface
IReplicationTaskDetails Interface
IReplicationTaskMonitor Interface
IReplicator Interface
ISchema Interface
ISchemaBasic Interface
ISchemaCommon Interface
ISchemaContent Interface
ISchemaField Interface
ISchemaFieldDefinitions Interface
ISchemaFieldFavorite Interface
ISchemaFieldProperty Interface
ISchemaFieldResult Interface
ISchemaFieldType Interface
ISchemaFieldTypeProperty Interface
ISchemaManager Interface
ISchemaSyncher Interface
ISchemaSynchManager Interface
ISchemaSyncLog Interface
ISchemaSystemSecurity Interface
ISchemaUnit Interface
ISchemaVersion Interface
ISchemaVersionCommon Interface
ISchemaWithVersions Interface
ISchemaWithVersions<T> Interface
IScpReplicationTarget Interface
ISearchAssetsConfig Interface
ISearchBoost Interface
ISearchConfig Interface
ISearchConfigBatchSizes Interface
ISearchConfigSetting Interface
ISearchDocumentLocation Interface
ISearchExclusion Interface
ISearchExclusionAndBoostBase Interface
ISearchFieldException Interface
ISearchFieldsConfig Interface
ISearchItemWithPubTargets Interface
ISearchSchemaDefinition Interface
ISearchSchemaException Interface
ISearchSchemaExclusion Interface
ISearchSchemasConfig Interface
ISecurityDescriptor Interface
ISecurityDescriptorsManager Interface
ISettings Interface
ISFTPReplicationTarget Interface
ISite Interface
ISiteBranding Interface
ISiteContentLocalizationProvider Interface
ISiteEvents Interface
ISiteMap Interface
IStep Interface
IStepWithWeight Interface
IStorageQuota Interface
IStructuredUrlSettings Interface
IStylesheet Interface
ITaskMonitor Interface
ITaxonomyEvents Interface
ITaxonomyManager Interface
ITechnicalMetadata Interface
ITextTechnicalMetadata Interface
ITinyMceConfig Interface
ITinyMceGroupProfile Interface
ITinyMcePossibleSettings Interface
ITinyMceSetting Interface
ITinyMceTemplate Interface
ITinyMceUserProfile Interface
ITransactionalEntity Interface
ITransition Interface
ITransitionUserInterface Interface
ITreeMenuConfig Interface
ITreeMenuItem Interface
ITreeMenuProfile Interface
IUnmanagedAsset Interface
IUnmanagedAssetFolder Interface
IUnmanagedAssetItem Interface
IUnmanagedAssetManager Interface
IUrlMap Interface
IUrlMapPageEntry Interface
IUrlMapPageHistoryEntry Interface
IUser Interface
IUserActivities Interface
IUserActivityPageEntry Interface
IUserAgent Interface
IUserEvents Interface
IUserGroup Interface
IUserGroupEvents Interface
IUserManager Interface
IUserProfile Interface
IUserRights Interface
IUserSession Interface
IUserWriteSession Interface
IVideoTechnicalMetadata Interface
IVisualTechnicalMetadata Interface
IWorkflow Interface
IWorkflowAttribute Interface
IWorkflowDefinition Interface
IWorkflowLogEntry Interface
IWorkflowManager Interface
IWorkflowTransitionEvents Interface
IWorkState Interface
IWorldViewSettings Interface
IXmlTechnicalMetadata Interface
IXsltTechnicalMetadata Interface
Click or drag to resize

Ingeniux.CMS Namespace
 
Classes
  Class Description
Public class ChoicesProviderApplicableCondition Describes the when this provider should provide the choices to an element. This object provides the logic to decide whether the provider to which it belongs should be used to provide element choices, based on the combination of SchemaName and ElementNames.
Public class ChoicesProviderOptions Contains information on how the choices for a enumerative element should be presented.
Public class Code example ContentStore The entry object to Ingeniux Content Store API. It is in charge of creating all communication sessions with the content store. This object should only be created once per app domain.
Public class IndexableEntityBuilder  
Public class IndexableEntityBuilderSettings Obsolete.
Interfaces
  Interface Description
Public interface Code example IAction

Represents a task to be completed when a transition is executed. An action is associated with a transition through the AddAction(EnumActionType, String) method.

There are actions for common operations in the content tree, such as checking in a page and marking a page for publish. If the built-in actions are not adequate, developers can create custom workflow actions. Custom workflow actions assemblies must be put in App_Data/xml/custom/plugins/CustomWorkflowActions directory. The actual Action class must implement the ICustomWorkflowAction interface. The custom action uses its full class name as the value of the ProgID attribute and calls the Execute method to perform the action.

The actions associated with a transition are executed in the order in which they are added to the transition. If an action fails to execute, the transition will not complete. The workflow remains in the WorkState it was in before the transition executed.

Public interface Code example IActionTypeAttribute Represents a list of attribute names required for a particular type of workflow action.
Public interface IArchiver Represents an archiver that can archive objects of a specific type
Public interface Code example IAsset

Represents an asset in the Assets Tree within a particular Site.

It can be retrieved via Asset method from the Site object.
Public interface Code example IAssetAdminContentDirect

Used to access admin level content and actions on an asset. Cannot be accessed directly. A retrieved asset needs to be recast as IAssetAdminContentDirect.
Public interface IAssetElement Represents an Asset Element that refers to a specific Asset.
Public interface IAssetEvents Represents the collection of Asset events.
Public interface Code example IAssetFolder

Represents a folder in the Assets Tree within a particular Site

It can be retrieved via AssetFolder method from the Site object.
Public interface IAssetFolderSchema Interface representing a
Public interface IAssetItem Represents a generic item in the Assets Tree. Used to abstract general functionality for IAsset and IAssetFolder.
Public interface IAssetManager 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.

C#
Copy
using (IUserSession session = store.OpenReadSession(currentUser))
{
    ISite site = session.Site;
    ...
}
Public interface IAssetManagerEvents Represents a collection of asset manager events
Public interface IAssetMap Represents an Asset Map.
Public interface IAssetMapEntry Represents an Asset Map Entry
Public interface IAssetNodeLevelPermission Represents a unit of security permission to apply to a particular asset folder or file.
Public interface IAssetPathHistoryEntry Represents an Asset Path History Entry
Public interface IAssetPublisher Represents the system that processes Asset file copying during publish/replication.
Public interface IAssetRelations Represents a set of Assets related to another Asset. Each relation has a unique name.
Public interface IAssetSchema Represents a schema for an Asset. All Assets in the Ingeniux CMS are created from a schema, which defines Asset metadata structure.
Public interface IAssetSchemaBasic Represents the properties shared by AssetSchema and AssetSchemaVersion objects
Public interface IAssetSchemaVersion Represents a version entry of a Asset Schema. Can be the current version or the previous version.
Public interface IAssetSecurityEntry Represents a security permission entry for an asset file or folder. Holds a collection of asset node-level permissions.
Public interface IAssetSecurityManager Represents the manager object that manages asset security entries.
Public interface IAssetStorageManager Represents the collection of functionalities for managing Asset file storage.
Public interface IAssetStorageTrack Represents the tracking information of Asset storage
Public interface IAssetVersion Represents the metadata and storage quota of a Asset at a specific stage in the page's history.
Public interface IAttribute Represents an attribute in Page or Element content, or in a Workflow Action. Attributes are always uniquely named. Attribute objects are already serialized into an XAttribute object.
Public interface IAudioTechnicalMetadata Represents technical metadata of an Asset with audio content
Public interface Code example IAudit_Entity Represents an entity within an audit entry. This interface captures the most fundamental information regarding the entity that is involved in the action being tracked.
Public interface Code example IAudit_User Represents the user that performs the action on the entity tracked in AuditEntry.
Public interface Code example IAuditEntry Presents an entry in the Audit Trail system. This entry stores the information regarding what entity was modified, which user worked on the entity, and what type of action was performed on that entity.
Public interface Code example IAuditTrail Represents the Audit Trail system. This system allows you to retrieve audit entries and add new entries. The Audit Trail system automatically creates entries after entities are created, updated, or deleted in the content store.
Public interface Code example IAuditTrailSettings Represents the settings of Audit Trail and contains its archive status.
Public interface IAWSReplicationTarget Represents a destination for published file replication using an Amazon Simple Storage Service (S3), as well as corresponding settings for this location.
Public interface IAzureStorageReplicationTarget Represents a Azure storage location for published files to be replicated to, as well as corresponding settings for this location.
Public interface IBlockedGroupsSecurityCollectionTManager Represents a collection of Users and Groups that are not allowed
Public interface IBrandEntryBase Represents the base of branding entries (Site, UserAgent). This is a branding system used only for XSLT rendering.
Public interface ICategoryEvents Represents the collections of CategoryNode events.
Public interface Code example ICategoryNode

Represents one CategoryNode in the Taxonomy tree.

Categories are used to tag Page objects, creating another way to organize and index Page objects.

The Taxonomy system is hierarchical. Each CategoryNode may have parent and children nodes.

Public interface ICategorySynonym

Represents a Synonym entry for a CategoryNode.

The Category Synonym is another name of the CategoryNode that is specific to a Locale.

Public interface ICategoryTranslation Represents a translation entry of a CategoryNode under a specific locale.
Public interface IComponentElement Represents a Component Element, that either refers to a specific component, or embed the component content within.
Public interface IContentFreezeState Represents the state of Content Freeze, which only allows a limited number of users to open read/write sessions.
Public interface IContentItem Represents the base of a content item object that has the following properties:

1. Has multiple versions

2. Can be checked out and checked in

3. Contains content including elements and attributes

4. Can be added and advanced in workflow

5. Always created from a Schema

6. Part of a tree structure
Public interface IContentItemT, TVersion, TSchema, TSchemaVersion Represents the content item object that can be created from a specific combination of Schema type and Schema version type
Public interface IContentItemMarking Represents a collection of functionalities on Content Items association with this Publishing Target.
Public interface IContentItemPublishStep Represents a step in the Publishing Tasks Monitor.
Public interface IContentItemVersion Represents the base version object of a content item object that has the following properties:

1. Has multiple versions

2. Can be checked out and checked in

3. Contains content including elements and attributes

4. Can be added and advanced in workflow

5. Always created from a Schema

6. Part of a tree structure
Public interface IContentItemVersionTSchema, TSchemaVersion Represents the content item version object that can be created from a specific combination of Schema type and Schema version type
Public interface Code example IContentItemWorkflowSuper Allows for elevating of permissions on a content item. This is used to allow actions to be done to an item, such as by workflow transitions, when users normally cannot perform those actions manually.
Public interface IContentStore Represents the object that hosts the content of a CMS instance. There should be only one instance of this object created per App Domain. For a CMS Site, this object is always stored as an application variable that persists throughout the CMS application's lifecycle. Any integration work at the CSAPI level should only use one ContentStore instance per App Domain.
Public interface IContentStoreEvents Content store events: The content store subscribes to all the events below and relays event firings to the corresponding managers or objects.
Public interface IContentStoreMetaData Contains ContentStore metadata. These are the basic settings of a CMS site.
Public interface ICSSTechnicalMetadata Represents technical metadata of an Asset with CSS (Cascading Style Sheets) content, variation of CSS content.
Public interface ICustomLocale Represents a custom locale. It is used to extend the list of ISO locales and to allow more choices of languages in the WorldView system.
Public interface ICustomTabsConfig Represents the configuration for the Custom Tabs system in CMS.
Public interface ICustomTabSetting Represents the settings for a custom tab interface displayed on CMS UI
Public interface ICustomWorkflowAction Represents the base interface for custom workflow actions. All custom workflow action implementations must use this interface so that the workflow engine picks up custom actions.
Public interface IDashboardPreferences Represents the settings for Dashboard display of CMS
Public interface IDescriptiveMetadata Represents a Dublin Core standard set of descriptive meta for an Asset.
Public interface IDevice

Represents a mobile device-web browser combination with unique UserAgent string. A device entry with this UserAgent string can be uniquely identified by Ingeniux CMS' mobile device detection system.

Public interface Code example IDeviceBundle Represents a collection of device-browser combinations that share a manufacturer and screen size.
Public interface IElement Represents an element field on a CMS Page. Its parent can be a Page or an Element. It is a collection of Attributes, plus field name and value, that can be serialized to an XElement.
Public interface IEmailer Represents an SMTP utility that provides email functionality within the CSAPI.
Public interface IEntity Represents an object that has a unique ID and name; has a list of update information; and can be serialized to XML. Entities should only be manipulated within a UserWriteSession. Also, it should only have its methods and properties called within the UserSession where it was originally retrieved.
Public interface IEntityTManager Represents an entity type that is associated with a specific manager type.
Public interface IEntityEvents Represents the collection of Entity events.
Public interface Code example IEnumerationElementChoicesProvider Represents objects that provide choices for selection-type elements. The CSAPI searches for concrete classes that implement this interface to provide actual choices
Public interface IExportDefinition

Represents an entry in the exports of a NavigationElement.

Exports are additional attributes appended to an expanded Link or Navigation XML element, adding more information to the Link or Navigation entry.

This interface is used for SchemaFields on Schemas and for GlobalExports. It is not for LocalExports on Navigation elements for Pages.

Public interface Code example IExportElement Represents a local export entry in Navigation and Link elements. Defines an additional XML attribute to be included in an page element's output.
Public interface Code example IExportsElement Represents the collection of local export entries in Navigation and Link elements. Defines an additional XML attribute to be included in a Page element's output.
Public interface IFileReplicationItem Represents a File replication item and its replication status.
Public interface IFileReplicationTarget Represents a file location for published files to be replicated to, as well as corresponding settings for this location.
Public interface IFileTypeLimitation Represents the limitation of extensions, from a specific Asset type.
Public interface IFinalizeCloneInfo Represents the information of a page's Lingual Version Map's finalization. This information is only be available when the lingual version map is finalized.
Public interface IFTPReplicationTarget Represents a FTP server location for published files to be replicated to, as well as corresponding settings for this location.
Public interface IFTPSReplicationTarget Represents an FTPS server location for published files to be replicated to, as well as corresponding settings for this location.
Public interface IGenericDevice Represents the generic mobile device for simulation purposes. This is the device to fall back on when it's determined the that browser is mobile but the exact device type is unknown. The purpose is to define the screen width and height of the fallback device.
Public interface IGlobalExportEntries Represents the collection of global exports definitions.
Public interface IGlobalExports Represents the Manager object that manages all global Exports for all Navigation Elements across all Pages.
Public interface Code example IGlobalVariable

Represents the Global Variable entry. As the name indicates, global variables are placeholders that hold specific values They can be used in any part of an element value or attribute. The purpose of this object is to allow static information that is repeated across multiple pages or fields to be editable in only one place.

Global variables always have a global value, which applies to all publishing targets. They may also contain override values for specific publishing targets. During publish, these override values are used for the publishing targets to which the global variables belong.

Global variables are defined in the CMS and undergo value replacement in the DSS.

Public interface IGlobalVariablesCollection Represents the Manager object that manages global variables.
Public interface IGroupElement

Represents a Group element on a page.

A Group element contains child elements of any type, except another group element.

Public interface IGroupRole Represents a specific permissions set that is stored and provides a way to set permission on a Group.
Public interface IHierarchyId Obsolete.
The object that stores hierarchy information on an entity.
Public interface IImageTechnicalMetadata Represents technical metadata of an Asset with image content
Public interface IIndexableEntityBuilder Obsolete.
Represents a builder for indexable entities
Public interface IInstanceLogger Represents logging functionality using the NLog library.
Public interface IJsonTechnicalMetadata Represents technical metadata of an Asset with JSON (Javascript Object Notation) content
Public interface Code example ILanguageSpecificMetaData

Represents an object that holds a set of string values, unique by their locale.

All the string value have the same meaning, but expressed differently depending on its language.

Example

Copy Right information of an Asset in various languages:

English: Ingeniux Corporation 2018, All right reserved.

Chinese: Ingeniux Corporation 2018, 保留所有权利。

Japanese: Ingeniux Corporation 2018, すべての権利を保有。

German: Ingeniux Corporation 2018, Alle Rechte vorbehalten.
Public interface ILingualMappingManager Represents the manager object that is in charge of lingual mapping between pages. Lingual maps are an essential part of the Ingeniux WorldView system
Public interface ILingualPageMap Represents a lingual relation between 2 pages. It includes the information of master and clone pages unique ids and locales.
Public interface ILingualPageVersionMap

Represents the lingual relationship mapping for specific version of the master page. This object is an entry in LingualPageMap.

Localization of web pages starts with the source language page (master page). In the beginning, the source language content is finalized and checked in, but there is no translation of this page in the target language. This will be the first entry in lingual map of this master page. It has a version for source page, but doesn't have a version for target page yet. As translation finishes, this lingual version map is finalized. It contains the target language page (clone page) version number. At this point, this version map is closed and kept in history of the master page's translations.

Public interface ILinkElement Represents a single page summarization, a reference to an external URL, or a reference to a document asset.
Public interface IListElement Represents a List element. List elements can have child elements of the same type. It must have at least one child element, but there is no upper limit on how many child elements it can have. The child element type can be any type, excluding Group and List elements.
Public interface IListStep

Represents the information of a step/task entry in a background task to be monitored. This step has a collection of sub-steps.

Sub-steps need not have a particular order. List steps can advance from one step to any other step.

Public interface ILocale Represents a standard ISO locale definition. The concept of locale is a combination of language and region. A more common term to describe a locale is "culture."
Public interface ILocalesManager Represents the entity that holds the collection of custom locales. Also provides the the functionality to list or retrieve standard ISO locales.
Public interface ILocaleSpecific Represents the properties of Content Items on Region Roots placements.
Public interface ILoggingManager A manager interface for accessing, creating, and updating publishing logs and replication logs.
Public interface IManagersHost Represents collection of all user-specific, session-specific, and publically available Manager objects.
Public interface Code example IMobileDeviceManager Represents the manager object that contains the collection of Device Bundles. Also, it can retrieve the information of a device from the Ingeniux CMS mobile detection library.
Public interface IMultiEntryMetadata Represents an object that holds a collection of string values.
Public interface Code example INavigationElement

Represents the types of XPower elements that produce a collection of Navigation elements during runtime or publishing expansion. A Navigation element queries each page it covers and produces a Page element with a set of attributes that summarizes the page's content.

The highly organized and highly flexible Navigation elements are a central part of the Ingeniux CMS.

The amount of information to summarize from page content is decided by the combination of global exports and local exports. Local exports override global exports with same name. Therefore, all Navigation element types can have local exports.

Public interface Code example INodeLevelPermission Represents a unit of security permission to apply to a particular object. The object represents a node in the tree structure.
Public interface INotification Represents a notification message
Public interface INotificationManager Represents the manager object to manage the collection of notifications
Public interface Code example IPage

Represents a node in the content tree within a particular Site. It can be retrieved via Page method from the Site object.

Pages are the building blocks of a CMS Site. Each Page object represents a structured piece of content that represents either a URL on the runtime site or a content block to be included in other pages.

Public interface IPageContent Represents the entity that contains the XML serialization of a Page Version. Page contents are used for preview and publishing.
Public interface Code example IPageCreationRule

Defines the criteria for creating a new Page, including Schema, location, and limitations on Groups and Users.

Page creation rules provide a controlled way to create pages; their main purpose is to enforce restrictions on page creation for nonadministrative users.

Because they provide ways to limit page creation locations, they can also be a used as shortcuts for creating pages quickly.

In addition, page creation rules can add newly created pages directly into workflows.
Public interface IPageCreationRuleEntryForPage Represents page creation information on a specific page.
Public interface Code example IPageCreationRulesManager Represents the manager object that provides the means to query and manage Page Creation Rules.
Public interface IPageEvents Represents the collection of Page events.
Public interface Code example IPageVersion Represents the content of a Page at a specific stage in the page's history. The Page Version object contains Elements and Attributes on the page content, the Presentations of the Page, and references to the page and its Schema Version.
Public interface IPathHistoryEntry Represents a path history entry.
Public interface IPathMap Represents a Path Map
Public interface IPathMapEntry Represents a Content Item in the collection of path maps.
Public interface IPathMapEntryTHistory Represents a Content Item in the collection of path maps.
Public interface IPcrOverridesDocument Represents a Page Creation Rule localization override document for handling translations of Page Creation Rules into various languages for display on the user interfaces of Ingeniux CMS clients.
Public interface IPCRParentPage Represents an entry in the parent Pages collection of a Page Creation Rule. It contains the parent page's information as well as whether or not this entry includes the parent page's descendants.
Public interface IPresentationSystemSecurity Represents the settings of the User or Group that accesses a Presentation Content Unit.
Public interface IPublishError Represents a nonstopping error that occured during the execution of a Publishing Task.
Public interface Code example IPublishingManager Represents the manager object that provides the means to query and manage the following publishing- and runtime-related objects:

Publishing Targets, Publishing Profiles, Structured Url Maps, Runtime Redirects, Replication System, Publishing Tasks and Replication Tasks.

It also provides ways to manage InSite Search configuration of CMS published content.
Public interface IPublishingPageEntry Represents a Page to be published in a Publishing Task.
Public interface IPublishingProfile

Represents a collection of Publishing Targets. Publishing profiles serve two purposes:

Public interface IPublishingSystemSecurity Represents the settings of the User or Group that accesses a Publishing Target.
Public interface Code example IPublishingTarget Represents the location to which a list of marked Pages is published as well as the settings on how the published contents get replicated. Also provides information on how the Dynamic Site Server hosts the published content in a runtime environment.
Public interface IPublishingTargetEvents Represent the collection of Publishing Target events.
Public interface IPublishingTargetVariable Represents a override value for a Global Variable for a specific Publishing Target. This value applies during both preview and publish for this Publishing Target.
Public interface Code example IPublishingTask Represents a task to publish a set of Pages and assets.
Public interface IPublishingTaskEvents Represents the collection of Publishing Task events
Public interface IPublishLog Represents a log of all of the data relevant to a publish. Publish logs consist of multiple entries.
Public interface IPublishLogSummary Represents the collection of information regarding all the publish logs for this target.
Public interface IPublishTaskMonitor Represents the collection of information that indicates the status of a Publishing Target's ongoing Publishing Task. Has more details than the ITaskMonitor and Content Store storage presence.
Public interface IReadonlyUser Represents the basic collection of information to be used to create a Session.
Public interface IRedirect Represents an entry in the run-time redirects maps. It is defined as design-time and published to each Publishing Target's target folder.
Public interface IReferenceEntry Represents a reference from one Page to another Page. This object is created on the fly; it's not an entity stored in Content Store.
Public interface Code example IReferencesManager Represents the manager object that provides a means to query and manage the Page cross references collection. The references system provides a different way to relate pages Pages in a nonorganized way. To relate pages in an organized way, the Taxonomy System is recommended solution.
Public interface IReplicationAdditionalLocation Represents a location that is not in the Publishing Target Folder, but will be replicated to a destination location during replication.
Public interface IReplicationCleanupExemption Represents a location from the Replication Target's destination directory that will not be cleaned up during Clean Replication.
Public interface IReplicationExemption Represents the a relative path from Publishing Target Folder that will not be replicated.
Public interface IReplicationItem Represents an item to be replicated and its replication status. This is used to track replication progress.
Public interface IReplicationLog Represents a log of all of the data relevant to a replication. Replication logs consist of multiple entries.
Public interface Code example IReplicationTarget Represents a destination location to which published content is replicated as well as corresponding settings for this location.
Public interface IReplicationTaskDetails Represents the details of a completed replication.
Public interface IReplicationTaskMonitor Represents the Monitor object that tracks the status of an ongoing replication.
Public interface IReplicator Represents the replication mechanism of a Publishing Target. The Replicator object itself contains the collection of Replication Targets and is in charge of managing them.
Public interface Code example ISchema Represents a schema for a page. All pages in the Ingeniux CMS are created from a schema, which defines page structure. However, changes to a schema are not automatically applied to pages created from it. In order for a page's structure to stay in sync with a schema, you must sync it in schema designer.
Public interface ISchemaBasic Represents the properties shared by the Schema and SchemaVersion objects.
Public interface ISchemaCommon Interface representing common properties for all CMS types
Public interface ISchemaContent An interface for managing the content of an item. This could be page, component, or schema's content.
Public interface ISchemaField

Represents a field in schema. It corresponds to an element or attribute in a page.

A schema contains a flat list of multiple fields.

Public interface Code example ISchemaFieldDefinitions Represents the collection of built-in schema field types (Element and Attribute types) in the Ingeniux CMS. This collection contains all field types used to to construct a schema.
Public interface ISchemaFieldFavorite Represents a collection of fields with pre-filled values. It is used to group Fields that are most repeated across schemas. This way, when creating a new schema, fields can be conveniently added without additional typing.
Public interface ISchemaFieldProperty Represents a filled value for a schema favorite entry's field.
Public interface ISchemaFieldResult Represents the combination of a SchemaField's serialization result. It contains 3 pieces of xml to go to 2 different areas in the final Schema xml output
Public interface ISchemaFieldType Represents a built-in type of schema field in a schema (attribute or element in a page).
Public interface ISchemaFieldTypeProperty Represents an exclusive property of a Schema Field Type.
Public interface Code example ISchemaManager Represents the manager object that provides means to query and manage schemas and schema field favorites. It also provides the built-in field definitions.
Public interface ISchemaSyncher Represents an actor for performing schema syncs.
Public interface ISchemaSynchManager A manager for performing schema syncs.
Public interface ISchemaSyncLog Represents a log of all the data relevant to a schema sync.
Public interface ISchemaSystemSecurity Represents the settings of the User or Group that accesses a Schema.
Public interface ISchemaUnit Represents a field unit on a schema.
Public interface Code example ISchemaVersion Represents a version entry of a Schema. Can be the current version or the previous version.
Public interface ISchemaVersionCommon Represents the collection of common features in schema version objects.
Public interface ISchemaWithVersions Represents the common schema object's versioning features.
Public interface ISchemaWithVersionsT Represents the versioning features of schema objects with specific types of Schema Versions.
Public interface IScpReplicationTarget Represents a destination for published file replication through SCP (secure copy), as well as corresponding settings for this location.
Public interface ISearchAssetsConfig Interface that represents asset location configuration for search.
Public interface ISearchBoost Interface that represents a boost value configured in InSite search.
Public interface ISearchConfig Represents an entry in the run-time redirects maps. It is defined as design-time and published to each Publishing Target's target folder.
Public interface ISearchConfigBatchSizes Interface that represents batch size configuration for search.
Public interface ISearchConfigSetting Interface that represents a single search config setting.
Public interface ISearchDocumentLocation Interface that represents the document location for asset searches.
Public interface ISearchExclusion Interface that represents search field exclusions, allowing certain content item fields to be excluded from InSite Search.
Public interface ISearchExclusionAndBoostBase Base interface to represent search exclusions and boosts.
Public interface ISearchFieldException InSite Search Configuration: Representats a search indexing configuration entry for a Page's Element or Attribute, either within one Schema or across all Schemas. This allows to individually control search indexing on Page fields.
Public interface ISearchFieldsConfig Interface that represents search fields configuration.
Public interface ISearchItemWithPubTargets Interface that represents a search item and an associated list of publishing target IDs.
Public interface ISearchSchemaDefinition Interface that represents a schema search definition.
Public interface ISearchSchemaException InSite Search Configuration: Represents a search indexing configuration entry for a specific Page type. This configuration will affect indexing behaviors on all Pages created from the schema. Within each configuration entry, search indexing behaviors of each Elements and Attributes can be configured individually.
Public interface ISearchSchemaExclusion Interface that represents a schema exclusion in search, allowing certain content item schemas to be excluded from search.
Public interface ISearchSchemasConfig Interface that represents search schema configuration, allowing for schema exclusions.
Public interface ISecurityDescriptor Represents a security descriptor for a page or content item.
Public interface ISecurityDescriptorsManager Represents a Decurity Descriptors manager.
Public interface ISettings Represents the collection of settings of a Ingeniux CMS site instance.
Public interface ISFTPReplicationTarget Represents an SFTP server location for published files to be replicated to, as well as corresponding settings for this location.
Public interface Code example ISite

Represents the manager object that provides the means to query and manage Pages and Page Versions.

It is the most important manager, due to fact it manages the central pieces of CMS, the Pages.

Public interface Code example ISiteBranding Represents the site branding system, which defines cobranding at the server level. It is used only for XSLT rendering.

Each Site Branding entry corresponding to a presentation style collection. Site Branding at run time is determined by locating its search string on the request URL. If the search string is found on the request URL, site branding is applied.

In other words, site brandings allow for presentation style switching based on request URL, include host name, base URL, and query strings.

Public interface ISiteContentLocalizationProvider

Represents the Manager object that provides functionalities to manage translations of Schemas, Page Creation Rules, Workflow Defintions and States, into various languages for display on the user interfaces of Ingeniux CMS clients.

The translated Schemas will replace the original field label and help text on the Edit Form of a Page.

The translated Page Creation Rules will override the Page Creation Rule selection dialog's rule names.

The translated Workflow Definitions and Work States will change the labels of Workflow advancement dialogs.

Public interface ISiteEvents Represents the collection of Site object events.
Public interface ISiteMap Represents the manager object that manages the XSLT rendering branding system. It add entries to, removes entries from, and updates ISiteBranding and IUserAgent.
Public interface IStep

Represents the information of a step/task entry in a background task to be monitored. Steps are the building blocks of the Task Monitor, which is used to monitor the progress of a task.

Steps are normally constructed with full information during construction of a Task Monitor. Their property values cannot be changed.

Public interface IStepWithWeight Represents the information of a step/task entry in a background task to be monitored. By default, a step has one unit of weight in its Task Monitor. A step with weight can take multiple weight units. However, the units cannot be equal to or less than 0.
Public interface IStorageQuota Represents storage limitation of specific Asset type.
Public interface IStructuredUrlSettings Represents the settings of a structured URL for a specific Publishing Target.
Public interface IStylesheet Represents a XSLT style sheet file in either the "Stylesheets" asset root folder or in the App_Dat/xml/Stylesheets folder.
Public interface ITaskMonitor Represents the collection of information that indicates the status of a Publishing Task.
Public interface ITaxonomyEvents Represents the collection of events triggered by the Taxonomy system
Public interface Code example ITaxonomyManager Represents the manager object that provides a means to query and manage Category Nodes collections. ITaxonomyManager also manages the associations between pages and categories.
Public interface ITechnicalMetadata Represents the basic collection of an Asset file technical information.
Public interface ITextTechnicalMetadata Represents technical metadata of an Asset with textual content
Public interface ITinyMceConfig Represents a manager for Tiny MCE User and Group configuration profiles.
Public interface ITinyMceGroupProfile Represents a Tiny MCE profile for a CMS Group that stores the Group's XHTML Editor configuration Settings.
Public interface ITinyMcePossibleSettings Represents a collection of all possible XHTML Editor configuration Settings
Public interface ITinyMceSetting Represents an XHTML Editor setting.
Public interface ITinyMceTemplate Represents the Tiny MCE Profile for XHTML Editor Basic Settings.
Public interface ITinyMceUserProfile Represents a Tiny MCE profile for a CMS User that stores the User's XHTML Editor configuration Settings.
Public interface ITransactionalEntity The base interface for all manager objects. It manages one or more types of object collections in the content store. Transactional entities are exclusive to the sessions that initiated them, and cannot be used across sessions.
Public interface Code example ITransition

Represents a path between two Work States. When a Workflow advances from one workstate to another, it goes through a transition.

Transitions allow for ownership change of a page in workflow. Transitions can also can execute built-in or custom Actions.

Transitions are defined in Workflow Definitions and carried out in Workflow Instances.

Public interface ITransitionUserInterface Represents the settings for user-interface behavior when the transition is executed. This includes the toolbar icons and the enter/exit dialog settings.
Public interface ITreeMenuConfig Represents a manager for the Ingeniux CMS Page / Asset Tree Menus' User and Group configuration profiles.
Public interface ITreeMenuItem Represents a menu item in the Ingeniux CMS Page or Asset trees.
Public interface ITreeMenuProfile Represents the Group-specific configuration of the Ingeniux CMS tree.
Public interface IUnmanagedAsset Represents a legacy asset file, residing under UnmanagedAssetLocation, that is not managed by the CMS Asset system.
Public interface IUnmanagedAssetFolder Represents a legacy asset folder, residing under UnmanagedAssetLocation, that is not managed by the CMS Asset system
Public interface IUnmanagedAssetItem Represents the base interface for unmanaged asset and folder items. Unmanaged asset items are legacy asset files that are not managed by the CMS Asset system.
Public interface IUnmanagedAssetManager Represents the manager object that handles legacy asset files, that are not brought into the CMS Asset system.
Public interface IUrlMap Represents a collection of a Page's URLs on a specific Publishing Target.
Public interface IUrlMapPageEntry Represents a Page in the collection of URL maps.
Public interface IUrlMapPageHistoryEntry Represents a historical URL of a Page when published. A historical URL can be generated by renaming, moving, or deleting a Page, or it can be created manually as custom URL for a specific purpose.
Public interface IUser Represents a user in the Content Store. The Ingeniux CMS CSAPI is an protected environment that requires a user account to create any kind of reading or writing sessions.
Public interface IUserActivities Represents the collection of Pages and Asset Items with which a User interacted.
Public interface IUserActivityPageEntry Represents a single activity on a Page by a User.
Public interface Code example IUserAgent Represents a user agent branding. This is a branding system used only for XSLT rendering.

User agent branding is used to define cobranding at the client level. Each user agent branding entry corresponds to a presentation style collection. User agent branding at run time is determined by locating its search string on the requested, browser-specific user agent string. If the search string is found on the requested user agent, then this user agent branding is applied.

Creating user agent brandings allows presentation style switching based on browser type. This is mainly used for mobile-device detection.

Public interface IUserEvents Represents the collection of events triggered by User objects.
Public interface IUserGroup Represents a collection of Users that share the same Security Permissions.
Public interface IUserGroupEvents Represents the collection of events triggered by Group objects.
Public interface Code example IUserManager Represents the manager object that is in charge of managing Users and Groups.
Public interface IUserProfile Represents the information of user's publish profile and personal settings
Public interface IUserRights Represents the collection of security permissions for a Group or User. It contains two enum sections, each of which contains its own collection of permission types.
Public interface IUserSession Represents a communication session used to retrieve objects from the content store. It is also the place to get all manager instances.
Public interface IUserWriteSession Represents a communication session used not only to retrieve objects from the content store, but also to create, delete, and modify objects. It is also the place to get all manager instances.
Public interface IVideoTechnicalMetadata Represents technical metadata of an Asset with video content
Public interface IVisualTechnicalMetadata Represents technical metadata of an Asset with image or video content
Public interface Code example IWorkflow Represents the an instance of a Workflow Definition associated with a single Page. Once a Page is added to a Workflow, a new instance of the Workflow object is created and attached to the Page. This allows precise control of the Page's lifecycle. It's also a good way to track the history of actions that occur on the Page.
Public interface Code example IWorkflowAttribute Represents an attrbrite of a Workflow Action. Used to store the action's settings.
Public interface Code example IWorkflowDefinition Represents a definition of workflow. Defines a Transitions tree/loop to move Pages through, the Users to assign page to, and the Actions to perform on these transitions.
Public interface IWorkflowLogEntry Represents an entry in a Workflow's history. Each time a Transition is executed on the workflow, a log entry is created.
Public interface Code example IWorkflowManager Represents the manager object that provides the means to query and manage Workflow Definitions, Work States, and Workflow Log entry collections.
Public interface IWorkflowTransitionEvents Represents the collection of events fired during Transitions in Workflow
Public interface Code example IWorkState Represents a stage of a Workflow. Transitions push a Page from one workstate to another.
Public interface IWorldViewSettings Represents the Worldview Settings
Public interface IXmlTechnicalMetadata Represents technical metadata of an Asset with XML (Extensible Markup Language) content
Public interface IXsltTechnicalMetadata Represents technical metadata of an Asset with XSLT (Extensible Stylesheet Language) content
Enumerations
  Enumeration Description
Public enumeration AssetType The list of types of Asset
Public enumeration CSSType Represents the list of CSS formats
Public enumeration IGX_Dashboard_Options List of potential widgets that can show up on Ingeniux CMS Dashboard