Reports.getVisibleTemplates (Method)
Returns zero or more structures, each containing information on a site's template's.
Returns:
Reports_GetTemplates_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Category | PlainText | The template's category. |
| CategoryID | CategoryID_0 | The category's ID, or 0 if My Templates. |
| Dependencies | PlainText | A comma-delimited list of feature/license dependencies associated with this template. |
| Description | PlainText | The template's description. |
| ExampleURL | ValidURL_EmptyString | An example's URL or an empty string. |
| FileName | Filename | The template's file name. |
| ForPublicUse | Boolean | Boolean flag which when set to true indicates that the template is available for public use. |
| GifURL | ValidURL_EmptyString | The URL of the template's gif image. |
| PageID | PageID | The page's ID. |
| SubsiteID | SubsiteID | The ID of the subsite in which the template resides. |
| SubsiteURL | SubsiteURL | The server-relative URL of the template's subsite. |
| Title | NonNullString | The template's internal CommonSpot title. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| subsiteIDOrURL | SubsiteIDorURL_EmptyString | Required | The ID of the target subsite, or the server relative path to the target subsite, or an empty string for the current subsite. |
| searchString | String | Optional. Defaults to an empty string. | The text sought by CommonSpot in the title, description, or file name fields. |
| searchOperator | SearchOperator_EmptyString | Optional. Defaults to an empty string. | The type of search comparison to use; for example, 'Contains', 'Begins with', 'Equals', and so on. |
| includeTemplateImagePath | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot returns the template image's URL. Setting this to true slightly degrades performance. |
| categoryID | CategoryID_0 | Optional. Defaults to '0'. | A template's category ID. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'Title ASC'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
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