PageSet (Component)

 

Methods:

addMembers Adds one or more members to the end of the page set list.
changeOwner Changes the owner of a page set.
create Creates a page set.
delete Deletes a page set.
getElementUsage Returns zero or more structures, each containing information on pages that contain one or more page set elements.
getElementUsageCount Returns the number of pages that contain one or more page set elements that reference a page set.
getInfo Returns a structure containing general information on a PageSet; for example, the page set's availability, name, number of members, and so on.
getMembers Returns zero or more structures, each containing information on the members of a page set. Examples of this structure's members are 'ID', 'MyApproval', and 'MyWIP'.
getOwnerID Returns the ID of the user or group that owns this page set.
getReferringObjects Returns zero or more structure, each containing information about a referred object; for example, the link and page type, the page's title, and its subsite URL.
getReferringObjectsCount Returns the number of pages and objects with links to the specified page set.
getSubsiteID Returns the subsite ID of the subsite in which the specified page set resides.
move Moves a page set to the current subsite. If CommonSpot cannot move the page set, it throws an error and does not move the page set.
removeMember Removes a member page from a page set.
removeMembers Remove one or more members from a page set.
saveInfo Updates the standard metadata for the specified page set.
setMembers Replaces all members of a page set with a new set of pages.