FreshnessReminders.dismiss (Method)
Dismisses a freshness reminder.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| reminderID | ReminderID | Required | A reminder's ID. |
| comments | PlainText_2000 | Optional. Defaults to an empty string. | Comments indicating why a reminder was dismissed. |
Context:
| License Requirements | None |
| Permission Requirements | Contributor |
| Deny Context | None |
| Require Context | None |
| 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 |
|---|---|
| 23004 | The freshness reminder was already dismissed. |
Notes:
None