Site (Component)

The Site object's methods perform high-level tasks and obtain information about a site. Tasks that are performed include reassigning element ownership, suspending authoring, changing the site's description, and making the site active or inactive. Other methods provide information on these activities as well as information of admin menu customizations, menu context, statistics, stub file count, and the like.

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Customization is not supported for this component.

Methods:

authorizePrivilegedModule [L]	Associates a group with a module such that the module will always run with the group's permissions.
deauthorizePrivilegedModule [L]	Removes the association between a module and a group, removing the extended permissions from the module.
getAdminMenuCustomizations	Returns zero or more structures, each containing information about customized site administrator menu items; for example, the menu's name, description, and onclick action.
getAdminMenuSectionCustomizations	Returns zero or more structures containing information about customized site administrator menu sections. This includes information such as the section's description, name, and permissions.
getAlternateImageFormatList	Returns zero or more structures, each containing information about alternate image formats for a site. For example, each structure contains a description of the alternate format, height and width constraints, and so on.
getAuthorSuspendState	Returns a structure containing information about the site's 'Author Suspend State'. For example, when it will be suspended, a warning message, and so on.
getAvailableCustomModules	Returns list of available CFM modules in the 'customcf' directory at the current site root.
getAvailableForms	Returns zero or more records describing the resulting forms, based on the type specified (Bound Simple Form, Standard Simple Form, Custom Element, Metadata Form, Query By Example Form, XML Publication Definition).
getAvailableWidgets	Returns zero or more records describing the widgets available on Paperthin site for download.
getDynamicReasons	Returns the dynamic reasons and their human readable string.
getInfo	Returns a structure containing information about the current site; for example, 'authoringPermitted', 'AuthoringURL', 'DatabaseType', and so on.
getMenuContext	Returns a structure containing information about the current user's current menu context; for example, 'enabledMenuClassList', 'menuContextTimeStamp', and 'visibleMenuClassList'.
getPageLimitInfo	Returns the total count of pages and uploaded documents and the maximum limit.
getStatistics	Returns a structure that contains site statistics such as the number of pages, the number of pages pending approval, the number of images, and so on.
getStubFileCount	Returns how many stub files this site has. Because the site needs to have URLs that a browser can find, CommonSpot generates a stub file for each page containing an addressable URL. If changes are made to a page or to a page's template, CommonSpot regenerates the stub file.
getTreeItems	Returns zero or more structures, each containing information about each child object based upon the type of object and its parent. Structure members include the node's text, if the node is a leaf node, if the node is selectable, and so on.
reassignContentOwnership [L]	Reassigns content ownership from one or more users to a another user.
saveAuthorSuspendState [L]	Suspends or activates the site's authoring state.
saveState [L]	Sets a site's state to 'Active' or 'Inactive'.
updatePrivilegedModuleAuthorization [L]	Changes the group associated with the given module, replacing an existing group association.