Reports.getInactivePagesCount (Method)
Returns the number of inactive pages . This method's arguments tell CommonSpot to return a number for a subset of these pages.
Returns:
NonNegativeInteger
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| userID | UserIDSpec | Optional. Defaults to '-1'. | A comma-delimited list of user IDs. Values that have special meaning are: 0: Returns information result for all owners. -1: Returns information results for all owners except the current user. |
| subsiteFilter | SubsiteFilter | Optional. Defaults to '0'. | The ID of the subsite in which CommonSpot searches for objects. If this argument's value is 0, CommonSpot searches all subsites. If this argument's value is -1, CommonSpot searches in the current subsite. |
| includeChildSubsites | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true tells CommonSpot that the results should include pages from child subsites. |
| dateFilterType | DateFilterType_EmptyString | Optional. Defaults to an empty string. | A string describing the date filter; for example, 'DateAdded' or 'PublicReleaseDate'. CommonSpot uses this value when looking for objects. If this argument is an empty string, CommonSpot does not use a date filter type. |
| dateFilter | DateFilterValue_EmptyString | Optional. Defaults to an empty string. | Sets the value of the filter that CommonSpot uses when returning results; for example 'This year', 'Last month', 'Last 2 months', and so on. |
| ownershipFilter | OwnerIDList_0_NEG1_NEG2 | Optional. Defaults to '-2'. | A string describing the ownershipfilter; for example, '0' for objects owned by current user and '-1' for objects owned by current user's groups and '-2' for objects owned by current user and his/her groups or a list of ownerIDs. |
Context:
| License Requirements | (none) |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | (none) |
| Require Context | Authoring |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None