Reports.getSubsitePagesAndDirs (Method)
Returns zero or more structures, each containing information about a subsite's directories and pages.
Returns:
Reports_GetSubsitePagesAndDirs_Result (rowlimitedquery)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| subsiteString | SubsiteURL_EmptyString | Optional. Defaults to an empty string. | The subsite's server-relative URL. You must use either this argument or the 'subsiteFilter' argument. This argument is ignored if the 'subsitefilter' is non 0. |
| 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. If this value is not 0 and a non-empty string 'subsitestring' argument is passed, then this value will be used and the 'subsitestring' argument will be ignored. |
| 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. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'PublicReleaseDate DESC'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
| limit | QueryRowLimit | Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'. | An integer specifying one more than the maximum number of rows CommonSpot can return. Special values are: 0: Returns all records. -1: Returns the number of records specified in the UI scalability setting. |
| displayDate | DisplayDate | Optional. Defaults to 'DateContentLastModified'. | A string describing the date field to display; for example, 'DateModified' or 'PublicReleaseDate'. |
| includeSubsites | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true tells CommonSpot that the results should include subsites, as well as pages. |
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 | Customization is not supported for this method. |
Error Codes:
None
Notes:
None