Publishing API

One of the main purposes of the PAPI is to be used by template designers when writing the script code within navigation and page templates. The PAPI gives template designers programmatic access to the entire hierarchy of channels and postings, and the various properties of those entities. Access to resource and template galleries, to templates themselves, to the placeholders within the templates, and to information about users, is also provided.

The following table lists the objects available in the 2001 version of the Publishing API and provides a brief description of each object.

Object	Description
AllowedValues	The AllowedValues object is a collection of allowed value strings and is returned by the AllowedValues property of the CustomProperty object.
Autosession	The Autosession object is the root object of the Content Management Server object model and is automatically available in all templates that include the file Authenticate.inc, which creates an instance of this object called Autosession. The methods and properties of this object provide a wide variety of functionality, including: User authentication Information about the current mode Access to the root containers of hierarchies
	Information about the current user's system-wide rights Database commitment Creation of new Searches objects
Channel	The Channel object stores the information required to store, organize, and manage access to postings, including information about the channel hierarchy.
Channels	The Channels object is a collection of Channel objects and contains several sorting methods.
ChannelsAndPostings	The ChannelsAndPostings object is a mixed collection of Channel and Posting objects and contains several sorting methods. This object is included in Content Management Server 2001 for backward compatibility only and will not be included in future versions.
CustomProperties	The CustomProperties object is a collection of CustomProperty objects and is returned by the CustomProperties property of the Channel and Posting objects.
CustomProperty	The CustomProperty object is used to access any custom properties used to extend certain objects. A CustomProperty object consists of a name/value pair and a list of allowed values.
Error	The Error object stores information about the last error that occurred in Content Management Server.
Placeholder	The Placeholder object is used to store an item of formatted content for a page. The properties of a Placeholder object determine the types of media they can store and the level of formatting allowed to content authors.
Placeholders	The Placeholders object is a collection of Placeholder objects.
Posting	The Posting object represents a posting stored in a channel and is a collection of references to the parts (the page template, resources, and placeholders) that make up an HTML page in Content Management Server. Note that the properties of the Posting object are a combination (union) of the properties of the posting and the properties of the page upon which the posting is based. In other words, the publishing API does not have a Page object, but page properties (visible in the Site Builder and Web Author user interfaces) are accessible programmatically through the Posting object.
Postings	The Postings object is a collection of Posting objects and provides several sorting methods.
Resource	The Resource object represents an item, such as an image or other multimedia file, stored in a Content Management Server resource gallery.
ResourceGalleries	The ResourceGalleries object is a collection of ResourceGallery objects and provides several sorting methods.
ResourceGallery	The ResourceGallery object stores the information required to retrieve resources from a resource gallery, including information about the resource gallery hierarchy.
Resources	The Resources object is a collection of Resource objects and provides several sorting and filtering methods.
Searches	The Searches object allows you to search for Channel, Posting, Template, TemplateGallery, Resource, and ResourceGallery objects that match specific criteria. Some searches will return a single object, while others will return a collection object.
SessionSettings	The SessionSettings object encapsulates adjustable settings of the Autosession object, such as settings to turn on or off certain automatic filters applied to collections.
Template	The Template object represents a page template stored in a Content Management Server template gallery.
TemplateGalleries	The TemplateGalleries object is a collection of TemplateGallery objects and provides several sorting methods.
TemplateGallery	The TemplateGallery object stores the information required to store, organize, and manage page templates and is used when navigating through the template gallery hierarchy.
Templates	The Templates object is a collection of Template objects and provides several sorting methods. Only page templates are available using this object; a template gallery containing both navigation and page templates will appear to contain only page templates.
User	The User object is used to represent Microsoft Windows NT and Lightweight Directory Access Protocol (LDAP) accounts and can access both the full and shortened names of a user. The properties of many other objects, such as the CreatedBy, OwnedBy, and LastModifiedBy properties, contain a User object rather than a string, allowing a site programmer more flexibility in choosing how to display user information.
Users	The Users object is a collection of User objects and is contained by the Approvers property of the Posting object.

Previous Next