Subsite (Component)

The methods within the Subsite object let you create, delete, and activate a subsite as well as obtain information about the subsite. For example, CommonSpot can return information about a subsite's ancestors, base template modules, context, directory URL information, and admin menu customizations.

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

Methods marked below with [C] may be customized at the site level

Methods:

activate [L] [C]	Activates or inactivates the current subsite.
create [L] [C]	Creates a new subsite under the current subsite.
delete [L] [C]	Deletes a child subsite.
getAdminMenuCustomizations [C]	Returns zero or more structures, each containing information about customized Subsite Administrator menu items; for example, the menu's name, description, the onclick action, and so on.
getAdminMenuSectionCustomizations [C]	Returns zero or more structures, each containing information about customized Subsite Administrator menu sections; for example, 'Class', 'Description', 'Name', and so on.
getAncestors [C]	Returns one or more structures, each containing subsite information and all of its ancestor subsites. If a subsite general security permission is passed, CommonSpot returns the value of that permission. These structures are returned in ascending order starting with the root subsite.
getBaseTemplateModules [C]	Returns zero or more structures, each containing information about the current subsite's base templates.
getChildSubsites [C]	Returns zero or more structures, each containing information about a subsite's child subsites; for examples, user permissions, the number of child subsites, the subsite's name, and so on.
getContext [C]	Returns a structure containing information about the current user's context; for example, the current site and subsite, their names and relative URLs, and so on.
getDirectoryURLInfo [C]	Returns a structure providing directory information for the subsite.
getForURL [C]	Returns the subsite information after resolving the subsite from the URL's directories.
getInfo [C]	Returns a structure containing general information for a subsite; for example, the subsite's name, ID, next and previous sibling subsites, and so on.
getStatistics [C]	Returns a structure that has statistics about the subsite; for example, the number of pages, uploaded documents, images, page sets, and so on. Optionally, this can include statistics for all of the subsite's descendants.
isActive [C]	Returns a Boolean flag indicating if a subsite is active.
reindex [L] [C]	Starts a job to re-index full-text search collections for a subsite.
rename [L] [C]	Renames the current subsite.