PageSet.getMembers (Method)

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'.

Returns:

PageSet_GetMembers_Result (query)

Each row of the returned query results has the following fields:

Field Name Type Description
Date Datetime The date and time requested by the value within this method's 'displayDate' argument.
Description PlainText_2000 The page's description.
FileName Filename The page's file name.
IconPath ServerRelativeURL_EmptyString A server-relative URL to the icon representing a page or document's type.
IconText PlainText Text associated with the icon representing the page or document.
ID PageID The ID of this page set member.
Link FileName_ValidURL_EmptyString The page's URL.
LockUserID LockUserID_0 The ID of the user holding the lock. This value is 0 if the page is not locked.
MyApprovalNeeded Boolean Boolean flag which when set to true indicates that the current user's approval is required.
MyWIP Boolean Boolean flag which when set to true indicates that the current user is still working on a page in the page set.
OthersApprovalNeeded Boolean Boolean flag which when set to true indicates that the current user needs other users to approve changes made within a page in this page set.
OthersWIP Boolean Boolean flag which when set to true indicates that other users are working on this page set member.
PageActivationStatus PageActivationStatus The activation status of the page: 0 (active), 1 (inactive), or 2 (inactive, active when published).
PageType PageType The page's type; for example, 0 (normal or uploaded document), 1 (template), 4 (custom element), or 6 (page set).
Scheduled Boolean Boolean flag which when set to true indicates that a page is scheduled for publication.
SubsiteURL SubsiteURL The server-relative URL of the page's subsite.
Title PlainText_NonNull_255 The page's title.

Arguments:

Name Type Required Description
pageSetID PageSetID Required A page set's ID.
displayDate DisplayDate Optional. Defaults to 'DateContentLastModified'. A string describing the date field; for example, as 'DateAdded', 'PublicReleaseDate', and so on.

Context:

License Requirements PageSet
Permission Requirements ContributorOrServerCode
Deny Context None
Require Context None
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization This method may be customized at the site level

Error Codes:

None

Notes:

None