Shortcuts (Component)

Shortcuts create quick access to commonly inserted pages, registered URLs, image files, uploaded documents, Global Custom Element data, and more. The Shortcuts object manages these shortcuts. Methods exist for creating, deleting, cloning, updating, setting the number of dashboard items, and so on. Other methods provide information on the shortcuts appearing in the user's dashboard.

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Customization is not supported for this component.

Methods:

changeOwner [L] Changes a shortcut's owner to a different user or group.
clone [L] Creates a new shortcut by copying an existing one.
create [L] Creates a new short cut.
delete [L] Deletes a shortcut.
deleteMultiple Deletes one or more shortcuts.
getAdminList 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.
getCustomizeList Returns zero or more structures, each containing information on the favorite new content shortcut records for the current user. Number of rows returned is limited by the Reports and Tools Maximum Records setting in Site Admin. See also getCustomizeList().
getFavoritesList Returns zero or more structures, each contain information on the favorite new content shortcuts records for the current user. Number of rows returned is limited by the 'My Favorite Shortcuts' maximum records setting in Site Admin. See also getCustomizeList().
getInfo Returns a structure containing information about a content shortcut.
getList Returns one or more structures, each containing shortcut information; for example, the shortcut's name, description, owner, if the current user can administer or edit the shortcut, and so on.
getMaxDashboardItems Returns the maximum number of shortcuts to display on the My CommonSpot dashboard.
getOwnerId Returns the ID of a user or group owning this shortcut.
saveFavoritesList [L] Saves the content shortcuts that will appear on the dashboard for the specified user.
setDefault [L] Sets or removes the specified shortcut as a default shortcut. If set as a default, also sets the position of the shortcut.
setFavorite [L] Sets this shortcut as the current user's favorite if the 'sFavorite' argument is set to true. If it iset to false, the shortcut will no longer be a favorite.
setMaxDashboardItems [L] Sets the maximum number of items that will appear on the My CommonSpot Dashboard.
update [L] Save a new or updates an existing content shortcut.