[This is preliminary documentation and is subject to change.]
SystemMarshalByRefObject
ContentStudioCSBase
ContentStudioCSApplication
Namespace: ContentStudio
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
The CSApplication type exposes the following members.
Name | Description | |
---|---|---|
CSApplication | Initializes a new instance of the CSApplication class |
Name | Description | |
---|---|---|
GetVersion |
Returns the version information for this instance of Content Studio server.
| |
GetVersionBuild |
Returns the build part of the version
| |
GetVersionMajor |
Returns the major part of the version
| |
GetVersionMinor |
Returns the minor part of the version
|
Name | Description | |
---|---|---|
CreateObjRef | (Inherited from MarshalByRefObject.) | |
Equals | (Inherited from Object.) | |
FetchInfo |
Returns a configurable collection of information about this instance of Content Studio
| |
Finalize | (Inherited from Object.) | |
GetDbSizeInformation |
Gets the size of the current Content Studio database.
| |
GetDocumentStatistics |
Gets the document statistics for a specific web site.
This statistic includes the
| |
GetHashCode | (Inherited from Object.) | |
GetLifetimeService | (Inherited from MarshalByRefObject.) | |
GetMEUIStructure |
Gets information about the structure of subfolders and their files in the Content Studio Modern Editor User Interface application.
This method was added in Content Studio version 5.7. | |
GetNamedMEUIResource |
Gets a named file resource of a Content Studio server Modern User Interface installation.
This method was added in Content Studio version 5.7. | |
GetNamedServerResource |
Gets a named file resource of a Content Studio server installation.
This method was added in Content Studio version 5.3. | |
GetNamedSiteResource |
Gets a named file resource of a Content Studio web site.
This method was added in Content Studio version 5.3. | |
GetServerResource |
Gets a specific Content Studio server resource.
This method was added in Content Studio version 5.3. | |
GetServerStructure |
Gets information about the structure of subfolders and their files in the Content Studio server application.
This method was added in Content Studio version 5.3. | |
GetSiteStructure |
Gets information about the structure of subfolders and their files in a Content Studio site,
for example the ~js folder that contains global script files - or the string representation of the
XmlSchema that describes the returned xml.
The method returns information about folders, subfolder and files that are not stored within Content Studio
and for that reason cannot be obtained with any of the regular API:s.
This method was added in Content Studio version 5.3. | |
GetType | (Inherited from Object.) | |
InitializeLifetimeService | (Inherited from MarshalByRefObject.) | |
IsAlive |
Returns true on calls. This method can be used for communication tests.
| |
IsSlaveInstallMode |
Returns true if this CS installation is in the slave mode.
| |
MemberwiseClone | (Inherited from Object.) | |
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) | |
RestartSite(ConnectionId, SessionId) |
Restarts the website.
| |
RestartSite(ConnectionId, SessionId, Int32, String) |
Restarts the website.
| |
SimpleSiteList |
Returns a simple list of sites registered on the server.
This list only contains the ConnectionId and is intended for the Service Manager only.
| |
SiteList |
Gets a list of all sites registered in certain installation of Content Studio
| |
SiteList(Boolean) |
Gets a list of all sites registered in certain installation of Content Studio.
| |
SiteListStream |
Gets a list of all sites registered in certain installation of Content Studio. The returned stream can be used as input to an XmlTextReader or an XmlDocument.
| |
SiteListStream(Boolean) |
Gets a list of all sites registered in certain installation of Content Studio. The returned stream can be used as input to an XmlTextReader or an XMLDocument.
| |
ToString | (Inherited from Object.) | |
TranslateMessage(Int32, CSApplicationSupportedLanguages) |
Translates a Content Studio message id to its textual representation in a certain language.
| |
TranslateMessage(CSException, CSApplicationSupportedLanguages) |
Translates a Content Studio message id to its textual representation in a certain language.
| |
TranslateMessage(Int32, CSApplicationSupportedLanguages, String) |
Translates a Content Studio message id to its textual representation in a certain language.
| |
TranslateMessage(String, Int32, String) |
Translates a Content Studio message id to its textual representation in a certain language.
| |
TranslateMessage(Int32, CSApplicationSupportedLanguages, Int32, String) |
Translates a Content Studio message id to its textual representation in a certain language.
| |
TranslateMessage(CSException, CSApplicationSupportedLanguages, Int32, String) |
Translates a Content Studio message id to its textual representation in a certain language.
| |
TranslateMessage(Int32, CSApplicationSupportedLanguages, String, Int32, String) |
Translates a Content Studio message id to its textual representation in a certain language.
|
Name | Description | |
---|---|---|
MaxActiveSessionsForExpressEdition |
Gets the maximum number of simultaneous user sessions that are allowed in Content Studio Express Edition
| |
MaxDatabaseSizeForExpressEdition |
Gets (in KB) the maximum allowed database space used for a site in Content Studio Express Edition.
|
The sample uses remoting configuration technique to enable the application to call CS API remotely.
This is technique has been documented in the article Calling Content Studio API externally in the Content Studio SDK.
using System; using System.Runtime.Remoting; using ContentStudio; namespace RemConfig { class Program { static void Main(string[] args) { try { //Configure the Remoting client channels by using the configuration file RemotingConfiguration.Configure("RemConfig.exe.config", true); //Get a list of all registered sites in content studio CSApplication csApp = new CSApplication(); using (System.Xml.XmlReader xrd = System.Xml.XmlReader.Create(csApp.SiteListStream(true))) { Console.WriteLine("Id\tName\t"); while (xrd.Read()) { if (xrd.NodeType != System.Xml.XmlNodeType.Element) continue; if (xrd.Name == "cs_site") { Console.Write(xrd.GetAttribute("connectionid")); Console.Write("\t"); Console.Write(xrd.GetAttribute("sitename")); Console.WriteLine(); } } xrd.Close(); } } catch (RemotingException rex) { Console.WriteLine("ERROR: There is a problem with your remoting configuration!"); Console.WriteLine(rex.Message); } catch (Exception ex) { Console.WriteLine("ERROR: There was problem with the call!"); Console.WriteLine(ex.Message); } Console.Read(); } } }