ContentStudio Namespace Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

This namespace is the root namespace in the Content Studio system. It contains application wide functionality such as the ability to log messages, get global information, licensing information and information about installed sites.
Classes

  Class Description
Public class Code example CSApplication
This class handles application wide data in Content Studio
Public class CSBase
This abstract class is the base of all classes in Content Studio.
Public class CSCustomAuthenticationFailedException
Defines a Content Studio exception thrown when a third party authentication provider failed. This exception defines a CSException with the Number set to 1034.
Public class CSCustomAuthenticationTokenException
Defines a Content Studio exception thrown when a third party authentication provider was given a token in the invalid format. This exception defines a CSException with the Number set to 1033.
Public class CSDocumentDeletedException
Defines a Content Studio exception thrown when a document is marked as deleted and placed in the recycling bin category. This exception defines a CSException with the Number set to 1801.
Public class CSDocumentNotFoundException
Defines a Content Studio exception thrown when a specified document does not exist. This exception defines a CSException with the Number set to 1100
Public class CSDocumentNotFoundInHierarchyException
Defines a Content Studio exception thrown when a specified document does not exist in a specified hierarchy. This exception defines a CSException with the Number set to 1113
Public class CSException
Defines an exception generated by Content Studio
Public class CSInvalidParameterException
Defines a Content Studio exception thrown when an invalid parameter value is passed int to a method call. This exception defines a CSException with the Number set to 1009
Public class CSInvalidSessionException
Defines a Content Studio exception thrown when a session ticket is invalid. This exception defines a CSException with the Number set to 1001
Public class CSPermissionDeniedException
Defines a Content Studio exception thrown when an permission denied condition is reached. This exception defines a CSException with the Number set to 1002
Public class CSXmlParser
This class facilitates the usage of the Content Studio parameters Xml. Callers can parse an existing ParametersXml document and return individual named parameter values. It is also possible to create a new ParametersXml document, add or remove named parameters to it and return it as in its string format using one of the overloaded ToString() methods. Parameter names are case-insensitive and is stored internally as lower case something that is reveled when you read the content as xml.
Public class DocumentStatisticsInformation
This class is used to return statistical information about document usage and status of a web site.
Public class ErrorManager
This class provides access to the Content Studio event log
Public class LicenseReader
This class handles license information in Content Studio
Public class SettingManager
This class provides access to the global settings in Content Studio.
Public class SiteContext
Represents a Content Studio web site.
Public class Sites
Represents a collection of SiteContext.
Public class SiteStructureReader

This class implements methods to read site structures in Content Studio.

This class was added in Content Studio version 5.3.

Public class SqlServerDatabaseSizeInfo
This information class is used by the GetDbSizeInformation(ConnectionId, SessionId) method when it returns information about the size of a database.
Structures

  Structure Description
Public structure ConnectionId
This class is used for sql connection identification
Interfaces

  Interface Description
Public interface IConfigurationRepository
Provides standard configuration data service components
Public interface IPageable
Provides paging functionality for a data reader or a collection that supports paging.
Public interface ITreeContainer

When implemented, describes a container item in a container and leaf based data structure.

This interface was added in Content Studio version 5.3.

Public interface ITreeItem

When implemented, describes a single leaf or container item in a container and leaf based data structure.

This interface was added in Content Studio version 5.3.

Public interface IUserSessionObject
Implements identifiers for a user session.
Enumerations

  Enumeration Description
Public enumeration CSApplicationCSInfoTypes
Types of information that can be returned in the FetchInfo function. These values can be combined if more than one info type should be returned.
Public enumeration CSApplicationResourceType
Public enumeration CSApplicationSupportedLanguages
Supported languages for error message translation.
Public enumeration CSEventLogSources
Defines the different log sources
Public enumeration LicenseReaderEditions
The license levels of Content Studio
Public enumeration LicenseReaderModules
Defines the different license modules in Content Studio
Public enumeration XMLSchemaTypes
Specifies the XML schema type to use