FreshnessReminders.snooze (Method)
Sets the amount of time that a freshness reminder sleeps. When this time period expires, CommonSpot changes the reminder's state to 'scheduled'.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| reminderID | ReminderID | Required | A reminder's ID. |
| snoozeUnit | TimeUnit | Required | The unit of time that the reminder snoozes, as follows: 'Days', 'Months', and 'Weeks'. |
| snoozeTime | PositiveInteger | Required | The amount of time to snooze. This value uses the unit set in the 'snoozeUnit' argument and can be 'Days', 'Months', or 'Weeks'. |
| comments | PlainText_2000 | Optional. Defaults to an empty string. | A reminder's comment. |
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:
| Code | Error Message |
|---|---|
| 23005 | The SnoozeTime value is not valid. |
| 23006 | Only active freshness reminders can be set to snoozed. |
Notes:
None