FreshnessReminders (Component)

CommonSpot lets users set reminders that changes should be made to content. These reminders are managed using the FreshnessReminders object. Reminders are always associated with a user or group and a page.

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:

clone [L]	Clones (copies) a freshness reminder.
delete [L]	Deletes a freshness reminder.
dismiss [L]	Dismisses a freshness reminder.
getCount	Returns the number of reminders contained within one or more subsites. This method's arguments limit the number of reminders that CommonSpot will count.
getInstance	Returns a structure containing information on a freshness reminder; for example, when the reminder is scheduled, who will be reminded, the reminder's text, and so on.
getList	Returns zero or more structures, each containing information about a reminder. This method's arguments let you indicate the reminders for which CommonSpot will return information.
getTypes	Returns one or more structures, each containing information on a reminder's ID and 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.).
getUsersAndGroups	Returns zero or more structures, each containing information about a user or group that has Admin, Author, or Edit permission for a page.
save [L]	Saves a new freshness reminder or updates an existing one.
snooze [L]	Sets the amount of time that a freshness reminder sleeps. When this time period expires, CommonSpot changes the reminder's state to 'scheduled'.