FreshnessReminders.getList (Method)
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.
Returns:
FreshnessReminders_GetList_Result (query)
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. A value of -1 indicates the current page's owner. |
| AssignedToFullName | Person_FirstNameMiddleNameLastName | The group name or the user's full name of the user or group to whom the reminder is assigned. |
| Date | DateTime_EmptyString | The date and time at which the reminder is displayed. This members 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. Can be a positive or negative number, or 0. |
| Description | PlainText | The reminder's description. |
| FileName | FileName_ValidURL_EmptyString | The page's filename, or if a registered URL a valid URL to which the reminder applies. |
| 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. |
| isUploadedDoc | Boolean | Boolean flag which when true indicates that the object is an uploaded document. |
| Link | FileName_ValidURL_EmptyString | The link of the page to which the reminder applies. |
| Owner | Person_FirstNameMiddleNameLastName | The full name of the reminder's owner. |
| OwnerID | UserID | The ID of the user who 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. |
| PageType | PageType | The type of the page or object to which freshness reminder is; for example, 0 (normal or uploaded document), 1 (template), 4 (custom element), or 6 (page set). |
| 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 an empty string, the reminder has not been resolved. |
| ResolutionByID | UserID_0 | The ID of the user who resolved the reminder. If this is a 0, the reminder has not been resolved. |
| ResolutionComment | PlainText | The resolution's comment. |
| ResolutionDate | DateTime_EmptyString | The date and time when the reminder was resolved. The format of this member is 'format yyyy-mm-dd'. If this an empty string, the reminder has not been 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 |
|---|---|---|---|
| filterType | ReminderTypeFilter | Required | The reminder type of the reminders retrieved by CommonSpot, which can be one of the following: 'All', 'Created By Me', 'Assigned To Me', 'Assigned to My Groups', 'Assigned to Me or My Groups'. |
| reminderState | ReminderStateFilter | Required | The state of the reminders retrieved by CommonSpot, which can be one of the following: 'Active', 'ActiveOrScheduled', 'All', 'Dismissal', and 'Scheduled'. |
| subsiteFilter | SubsiteFilter | Optional. Defaults to '0'. | The subsite's ID. If this value is -1, CommonSpot returns information on the current subsite. If this is 0, CommonSpot returns information for all subsites. |
| includeChildSubsites | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that CommonSpot includes child subsites in the results. |
| searchString | String | Optional. Defaults to an empty string. | A string within a reminder that CommonSpot looks for. It looks for a match in the Title and Description fields. An empty string indicates that these fields are not searched. |
| pageID | PageID_0 | Optional. Defaults to '0'. | A page's ID. If this value is 0, CommonSpot returns information for all of the subsite's pages. |
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:
None
Notes:
None