Page.getBrokenLinksCount (Method)
Returns the total number of broken links on a page.
Returns:
NonNegativeInteger
Arguments:
Name | Type | Required | Description |
---|---|---|---|
pageID | RealPageID_NonBaseTemplate | Required | The ID of a CommonSpot page or template. It cannot be an ID for uploaded documents, external URLs, images, and so on. |
versionStateList | HistoryCurrentWIP_List_EmptyString | Optional. Defaults to '2'. | A comma-delimited list of one or more integers representing version states; for example, a list member can have values such as 1(History), 2 (Current), 3 (WIP), or an empty string for all version states. |
linkStatusFilter | LinkStatusList | Optional. Defaults to 'Deleted,Broken'. | A comma delimited list of possible link statuses to be returned. Possible values include 'valid', 'broken', 'deleted', 'ignore', 'syntaxvalid' and 'unchecked'. |
includeTemplates | Boolean | Optional. Defaults to '0'. | Boolean value indicating if the templates from which the page is inherited should be included or not. |
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