Content (Component)
The Content object copies and moves documents from one subsite to another as well as deleting pages and documents. The object also provides information about why a copy or delete operation would fail and about user permissions to perform these operations.
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 [C] | Change the ownership of one or more pages, images, uploaded documents, registered URLS or pagesets. |
copyMultiple [C] | Copies one or more pages to the current subsite. If a page cannot be copied, CommonSpot throws an error. |
currentUserHasPermission [C] | Returns a Boolean flag which when true indicates that the current user has the permission for the page or image passed within the 'permission' argument. |
deleteMultiple [C] | Deletes one or more pages and documents. |
getCopyConflicts [C] | Returns a query with limited metadata for each given ID, along with status (one of OK,Failure,Warning) indicating whether an object can be copied to the given destination, and conflictReason, which contains a description for a non-OK result. |
getDeleteConflicts [C] | Returns a query with limited metadata for each given ID, along with status (one of OK,Failure,Warning) indicating whether an object can be deleted, and conflictReason, which contains a description for a non-OK result. |
getMetadata [C] | Returns a struct with metadata for a requested page, image, registered URL, multimedia file or playlist, etc.. |
getMetadataFields [C] | Returns a structure describing the metadata fields given the specified information. |
getMoveConflicts [C] | Returns a query with limited metadata for each given ID, along with status (one of OK,Failure,Warning) indicating whether an object can be moved to the given destination, and conflictReason, which contains a description for a non-OK result. |
getOwners [C] | Returns one or more structures, each containing information about the owners of the specified content object. |
getRenderHandlerMetadata [C] | Returns a struct with render handler metadata for the requested element on the requested page. |
getRequiredMetadataFields [C] | Returns a structure describing the required metadata fields given the specified information. |
getSummary [C] | Returns a structure containing basic information about a requested item. Item may be a CommonSpot page, uploaded document, etc. |
getURL [C] | Takes a ID of page/registeredURL/image/uploaded document or (multimedia file or playlist for 9.x) and returns URL to the CS object. |
getUserRights [C] | Returns a structure whose members contain information about a page's security; for example, all permissions, enforced approval level IDs, enforced permissions, and so on. |
moveMultiple [C] | Moves one or more pages and images to the current subsite. |
updateMetadata [L] [C] | Sets or clears (if empty string) the value one or more metadata fields for the specified content object (page, uploaded document, registered URL, page set or image). The value of any existing metadata fields that are not specified will not be changed. |