FreshnessReminders.save (Method)
Saves a new freshness reminder or updates an existing one.
Returns:
ReminderID (integer)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageID | PageID | Required | The ID of the page, uploaded document, registered URL, page set, or template to which the reminder is bound. |
| reminderID | ReminderID_0 | Required | A reminder's ID. If this value is 0, CommonSpot creates a new reminder instead of updating an existing one. |
| userGroupID | UserGroupID_ExcludingAnonAuth_NEG1 | Required | A user or group's ID. If this value is -1, CommonSpot saves a reminder for the current page's owner. You cannot set the ID of an anonymous author. |
| type | RemindOnType | Required | The reminders type. The type is a string that indicates when the reminder will become active; for example, a reminder can be issued after a content change. |
| title | PlainText_NonNull_255 | Required | The reminder's title. |
| description | PlainText | Required | The reminder's description. |
| isPublic | Boolean | Required | Boolean flag which when set to true indicates that the reminder is public. False means the reminder is private. |
| date | Date_EmptyString | Optional. Defaults to an empty string. | The date for which the freshness reminder is set. The format for this date is 'yyyy-mm-dd'. An empty string indicates that no date is associated with this reminder. |
| daysBeforeAfter | Integer | Optional. Defaults to '0'. | The number of days before (a positive integer) or (a negative integer) after a reminder is posted. It sets the number of days before or after an expiration or content change date. If the 'type' argument is 'SpecificDate', CommonSpot ignores this argument. |
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 |
|---|---|
| 23007 | You must specify the Date argument if Type is 'specificDate'. |
| 23008 | |
| 23009 | You must specify a value greater than or equal to 1 and less than or equal to 999 for 'Days after next content change'. |
| 23011 | Another freshness reminder with this name already exists. |
| 23012 | You have specified that a reminder will occur 'X days before Expiration'. However, the page is not set to expire. |
| 23014 | |
| 23015 | You cannot edit or view information for a private freshness reminder. |
Notes:
None