Page.getInfo (Method)

Returns a structure whose members contain page information; for example, 'Availability', 'EnableStyleSheets', 'FileName', and so on.

Returns:

Page_GetInfo_Result (struct)

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

Field Name Type Description
CacheSettings Any The cache's settings, which can be 'Dynamic', 'Static', or 'Unknown'.
Caption PlainText_255 The page's title and title bar caption.
DaysToShowVersionHistory DaysToShow Number of days that CommonSpot will show a page's version history. CommonSpot does not show history entries created before this day.
DaysToShowVersionHistoryAssignedAtPage Boolean Boolean flag which when set to true indicates that the 'DaysToShowVersionHistory' value was assigned at the page level. False indicates that the page uses the site's default.
EnableStyleSheets StyleSheetStatus An integer value indicating if style sheets are enabled for the page. as follows: 0 (yes) or , 2 (no).
expirationAction ExpirationAction_EmptyString The action CommonSpot will take if the page is expired and the user navigates to the document.
expirationRedirectURL ValidURL_EmptyString The URL to redirect to if the page is expired and expirationAction is set to 'Redirect'.
expirationWarningMsg PlainText_255 The warning message to display if the page is expired and expirationAction is set to 'Warn'.
FileName Filename The page's file name.
LanguageName LanguageName The page's language.
LockDate DateTime_EmptyString The date and time when CommonSpot locks the page or an empty string, which indicates that no lock exists.
LockUserID UserID_0 The ID of the user having the permanent lock. If this value is 0, no permanent lock exists.
LockUserName Person_FirstNameMiddleNameLastName_EmptyString The full name of the person with the pemanent lock. This is an empty string if no one has a pemanent lock.
Name PlainText_NonNull_255 The page's name.
PageActivationStatus PageActivationStatus An integer specifying the page's activation status: 0 (Active), 1 (Inactive), or 2 (Inactive, active when published).
PageActivationStatusDesc PlainText_NonNull_255 A description of the activation status.
ShowInList ShowInList_EmptyString A comma-delimited list of one or more 'showIn' values; for example, 'PageIndex', 'SearchResults', or an empty string.
StaticReason PlainText_NonNull The reason why CommonSpot set the page's static state.
StaticState StaticState A string specifying the static setting for the page; for example, 'Auto Dynamic', 'Auto Static', 'Forced Dynamic' and so on.
Subscription SubscriptionStatus An integer specifying if the current user has subscribed to the page: 0 (No subscription), 1 (Notify via MyCommonSpot Dashboard), 2 (Notify via Email), 3 (Notify via email and MyCommonSpot dashboard).

Arguments:

Name Type Required Description
pageID RealPageID Required A page's ID.

Context:

License Requirements None
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