Shortcuts.setFavorite (Method)
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.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| shortcutID | ShortcutID | Required | A shortcut's ID. |
| isFavorite | Boolean | Required | Boolean flag which when set to true tells CommonSpot to make this shortcut the current user's favorite saved search. |
| position | NonNegativeInteger | Optional. Defaults to '0'. | The position of a search in the current user's favorites list. Any item's position that is greater than or equal to this position has it position increased by one. If this value is 0, CommonSpot will place this shortcut at or near, the top of the favorite list. However, CommonSpot ignores this argument if the 'isFavorite' value is 0. |
Context:
| License Requirements | None |
| Permission Requirements | Contributor |
| Deny Context | None |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None