Rock Mobile Docs

Reminder List

Settings

NameDescription
Reminder Edit PageThe page to navigate to when a reminder is pressed.
Reminder Types IncludeThe reminder types to include. Leave all unchecked to include all reminder types (except for the reminder types selected in Reminder Type Exclude).
Reminder Type ExcludeThe reminder types to exclude. This setting is only effective if no specific reminder types are checked in Reminder Types Include.
Completion Display DelayThis is the amount of time, in milliseconds, that it will take from a reminder that has been completed/incompleted to be removed from the UI. This only actually happens if the reminder should no longer be displayed (e.g. filter is set to Incomplete, and you completed a reminder). This delay provides a window of time to undo an accidental mark of completion/incompletion.

Parameters

KeyTypeDescription
EntityTypeGuidGuidThe type of entity to display reminders for.
EntityGuidGuidThe entity to display reminders for.
ReminderTypeGuidGuidThe reminder type to limit this list to.
PersonGuidGuidThe specific Person to display reminders for.
GroupByTypeboolIf enabled, the reminders will be grouped by their ReminderType. Non-grouped is paginated and efficient for long lists. Grouped loads everything upfront, which is fine if counts are small but could be expensive with many reminders.
CollectionHeaderstringThe text to display at the top of the collection of reminders.
CompletionFilterCompletionFilterThe Completion Filter.
DueFilterDueFilterThe Due Filter.
StartDateFilterDateTimeOnly show reminders with a ReminderDate later than the value provided.
EndDateFilterDateTimeOnly show reminders with a ReminderDate that precedes the value provided.
ReminderTypeFilterGuidThe reminder type to filter this list to.
PageLoadSizeintThe amount of reminders to load at a time.

Completion Filter

This object is designed to provide filter information of the completion status of a reminder.

NameValueDescription
None0No completion filtering (incomplete & complete reminders shown).
Active1Limit to reminders that are currently active.
Complete2Limit to reminders that are completed.
Incomplete3Limit to reminders that are not complete.

Due Filter

This object is designed to provide filter information of the due date of a reminder.

NameValueDescription
None0No due date filtering.
Due1Limit to reminders that are past due.
DueThisWeek2Limit to reminders due this week.
DueThisMonth3Limit to reminders due this month.

Delete Reminder

C v16.1

Reminders can be deleted by swiping left on the reminder item.

v16.1

To link Person Alias reminders to a Person Profile page, ensure that a Profile Page is set in your application settings.

That page will be navigated to with PersonGuid passed along as the parameter.

Styling