FreshnessReminders.getInstance (Method)

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.

Returns:

FreshnessReminders_GetInstance_Result (struct)

Each row of the returned query results has the following fields:

Field Name	Type	Description
AssignedTo	UserGroupID_ExcludingAnonAuth_NEG1	A user or group ID to which this reminder is assigned. -1 indicates the current page's owner.
AssignedToFullName	Person_FirstNameMiddleNameLastName	The full name of the group or user's to which the reminder is assigned.
Date	DateTime_EmptyString	The date and time at which the reminder is displayed. Its format is 'format yyyy-mm-dd HH:mm:ss'. It can also be an empty string.
DaysBeforeAfter	Integer	The number of days before or after the reminder. This can be a positive or negative number, or 0.
Description	PlainText	The reminder's description.
isAssignedToUser	Boolean	Boolean flag which when true indicates that the reminder is assigned to the current user.
isOwner	Boolean	Boolean flag which when true indicates that the current user is the reminder's owner.
isPublic	Boolean	Boolean flag which when true indicates that the reminder is public.
Owner	PlainText_NonNull	The user or group name corresponding to the UserGroupID member.
OwnerID	OwnerID	The ID of the user or group who either owns or created the reminder.
PageID	PageID	The ID of the page to which the reminder applies.
PageTitle	PlainText_NonNull	The internal CommonSpot title of the page to which the reminder applies.
ReminderID	ReminderID	The reminder's ID.
ReminderTitle	PlainText_NonNull	The reminder's title.
ResolutionAction	NonNegativeInteger	A non-negative integer representing the reminder's resolution, as follows: 0 (no resolution), 1 (Snooze), or 2 (Dismissed).
ResolutionBy	Person_FirstNameMiddleNameLastName_EmptyString	The full name of the user who resolved the reminder. If this is an empty string, the reminder is not resolved.
ResolutionByID	UserID_0	The ID of the user who resolved the reminder. If this is a 0, the reminder is not resolved.
ResolutionComment	PlainText	The resolution's comment.
ResolutionDate	Date_EmptyString	The date and time when the reminder was resolved. The format of this member is 'format yyyy-mm-dd'. An empty string indicates that the reminder is not resolved.
State	ReminderState	A string describing the state of the reminder, as follows: 'Active', 'Dismissed', or 'Scheduled'.
SubSiteURL	SubsiteURL	The subsite of the page to which the reminder applies.
Type	RemindOnType	The reminder's type, which is one of the following: 'AfterNextContentChange', 'BeforeExpiration', or 'SpecificDate'.

Arguments:

Name	Type	Required	Description
reminderID	ReminderID	Required	A reminder's ID.

Context:

License Requirements	None
Permission Requirements	Contributor
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	Customization is not supported for this method.

Error Codes:

Code	Error Message
23015	You cannot edit or view information for a private freshness reminder.

Notes:

None