Shortcuts.getAdminList (Method)
Returns zero or more structures, each containing information about all or some of this site's shortcuts. This method's argument's set criteria that tell CommonSpot which shortcut information it should retrieve.
Returns:
Shortcuts_GetAdminList_Result (rowlimitedquery)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| type | ShortcutTypeFilter | Optional. Defaults to 'All'. | The type of shortcut that CommonSpot returns; for example, 'All', 'ExternalURL', 'GlobalCustomElement', 'Image', 'Page', or 'UploadedDocument'. |
| filter | SavedSearchShortcutAdminFilter | Optional. Defaults to 'All'. | A string identifying the kind of short cut that CommonSpot should look for; for example, 'All', 'ExternalURL', 'Element', and so on. |
| searchField | SavedSearchShortcutSearchField | Optional. Defaults to 'NameOrDescription'. | The field that CommonSpot searches, which is either 'NameOrOperation' or 'Owner'. |
| searchOperator | SearchOperator_EmptyString | Optional. Defaults to an empty string. | The search operator; for example, 'Begins With', 'Contains', 'Equals', and so on. |
| searchString | PlainText | Optional. Defaults to an empty string. | The string that CommonSpot searches for. |
| limit | QueryRowLimit | Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'. | A integer specifying one more than the maximum number of rows CommonSpot can return. If this value is 0, it returns all records. If it is -1, CommonSpot can return the number of records specified in the UI scalability setting. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'Name'. | An SQL 'order by' clause naming the field upon which the results will be sorted. |
| dateFilterType | DateFilterTypeNonPage_EmptyString | Optional. Defaults to an empty string. | A date filter type that CommonSpot uses when searching for elements that are not pages, as follows: 'DateFilter', 'DateContentLastModified', or an empty string. |
| dateFilter | DateFilterValue_EmptyString | Optional. Defaults to an empty string. | A date filter value or an empty string; for example, 'Last 2 months'. An empty string tells CommonSpot that it should not use a date filter value. |
| displayDate | DisplayDate | Optional. Defaults to 'DateContentLastModified'. | The date field displayed; for example, 'DateAdded', 'PublicReleaseDate', and so on. |
Context:
| License Requirements | None |
| Permission Requirements | site:ManageShortcutGallery |
| 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:
| Code | Error Message |
|---|---|
| 38007 | If you specify a search string, you must also specify a search operator. |
| 1000200 | If you specify a DateFilterType, you must also specify a DateFilter. |
| 1000201 | If you specify a DateFilter, you must specify a DateFilterType. |
Notes:
None