Page (Component)

The Page object manages a page and its attributes. For example: * General page management: Create, copy, delete, move, and move. * Attributes: Change ownership, push, pop, and set locks, and change mode. * Maintenance: Validate links, set cache properties, invalidate the cache, and send page for email review. * Return information: On a page, its site, its template, ownership, broken links, bookmarks, and many other attributes.

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:

changeOwner [L] [C]	Changes the ownership of a page or template. You cannot, however, change the ownership of a base template.
checkLock [C]	If another user has a lock on the requested page, CommonSpot displays a message that tells the user about this problem. If the page is not locked, CommonSpot returns and empty string. If 'throwIfLocked' is true, CommonSpot throws an error whose text is the same message.
copy [L] [C]	Copies the specified page to the specified subsite. If CommonSpot cannot copy the page, it throws an error.
create [L] [C]	Creates a page in the specified subsite.
delete [L] [C]	Deletes a page or template.
forcePermanentLock [L] [C]	Sets or removes a page's permanent lock. If you are removing a page's locks and other users have locks on the page, CommonSpot removes the locks held by all of these users.
getBookmarks [C]	Returns zero or more structures, each containing information on an element's bookmarks contained within a page. If the bookmark is contained inside a RTE, it is not returned.
getBrokenLinks [C]	Returns zero or more structures, each containing information about one of a page's broken links.
getBrokenLinksCount [C]	Returns the total number of broken links on a page.
getCacheProperties [C]	Returns a structure whose members contain information about a page's cache properties.
getContributors [C]	Returns zero or more structures, each containing information about a page's contributor.
getEditMenuPerms [C]	Returns a comma-delimited list of a page's Edit menu permissions.
getInfo [C]	Returns a structure whose members contain page information; for example, 'Availability', 'EnableStyleSheets', 'FileName', and so on.
getLanguageCounterparts [C]	Returns a query with all available language counterparts configured for the given page.
getLockStatus [C]	Returns a structure whose members contain page lock information. This includes the lock's type, who owns the lock, and so on.
getMoreActionsMenuPerms [C]	Returns a comma-delimited list of a page's 'More Actions' menu permissions; for example, these permissions can be 'CustomMetaData', 'Security', 'OtherProperties', and so on.
getOwnerID [C]	Returns the page owner's user ID.
getParentTemplates [C]	Returns one or more structures, each containing information about pages or templates related to a page's template hierarchy.
getPublishInfo [C]	Returns a structure containing information about a page's publication information; for example, 'DateContentLastModified', 'PublicReleaseDate', and so on.
getReferringObjects [C]	Returns zero or more structures, each containing information on a page or object that links or references this page.
getReferringObjectsCount [C]	Returns the number of pages and objects that link to a page.
getSiblings [C]	Returns zero or more structures, each containing information about pages or templates that have the same parent as the specified page.
getSubsiteID [C]	Returns the subsite ID of the subsite in which the specified page resides.
getTemplateHierarchyInfo [C]	Returns a structure containing information about the a page's template hierarchy.
getVarsFromURL [C]	Returns a structure whose members include the requested fields from the page's standard metadata. If 'fieldList' is set to an empty string, CommonSpot returns all fields.
ignoreLinks [L] [C]	Changes the link status of the specified link to be ignored.
invalidateCache [L] [C]	Invalidates all page's cache files. After being invalidated, the next request for the page causes CommonSpot to completely reconstruct the page and its elements.
move [L] [C]	Moves a page to the current subsite. If CommonSpot cannot move the page, it throws an error and does not move the page.
rename [L] [C]	Renames the specified page.
saveActivationState [L] [C]	Sets the activation state for a page to 'Activate', 'AutoActivate', or 'Inactive'.
saveActivationStateMultiple [C]	Sets the activation state for one or more pages to 'Activate', 'AutoActivate', or 'Inactive'.
saveCacheProperties [L] [C]	Saves a page's cache properties.
saveInfo [L] [C]	Saves information associated with a page; for example, its title, description, public release date, and so on.
saveVersionHistorySettings [L] [C]	Sets the number of days for which CommonSpot displays version history information. For example, if this is set to 180 days, CommonSpot does not display information for changes that occurred over 180 days ago.
sendEmailReview [C]	Emails a review copy of a page to the specified users and groups.
setPermanentLock [L] [C]	Sets or removes a page's permanent lock. When setting a lock, also takes any other user who was working on the page out of that mode. Throws an error if another user has a lock on the item.
switchMode [C]	Sets the working mode of a page to 'Approve', 'Author', 'Edit', or 'Read'.
validateLinks [C]	Validates a page's links and returns the number of links that are broken.