Zimlet JavaScript API Reference - ZmReminderController

Class ZmReminderController


This controller uses the following timed actions:

  1. one for refreshing our "cache" of upcoming appts to notify on
  2. one for when to next popup the reminder dialog. by default, next appt start time minus lead time pref (i..e, 5 minutes before). but, also could be controlled by snooze prefs.


Defined in: ZmReminderController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmReminderController(calController, apptType)
Creates a new reminder controller to manage the reminder dialog and status area.
Method Summary
Method Attributes Method Name and Description
 
dismissAppt(list, callback)
Dismisses an appointment.
 
Gets the reminder dialog.
 
Gets the search time range.
 
snoozeAppt(appts)
Snoozes the appointments.
Class Detail
ZmReminderController(calController, apptType)
Creates a new reminder controller to manage the reminder dialog and status area.
Parameters:
{ZmCalViewController} calController
the controller
apptType
Method Detail
dismissAppt(list, callback)
Dismisses an appointment. This method is called when an appointment (individually or as part of "dismiss all") is removed from reminders.
Parameters:
{AjxVector|Array} list
a list of ZmAppt objects
{AjxCallback} callback
a callback

{ZmReminderDialog} getReminderDialog()
Gets the reminder dialog.
Returns:
{ZmReminderDialog} the dialog

{Hash} getSearchTimeRange()
Gets the search time range.
Returns:
{Hash} a hash of parameters

{Array} snoozeAppt(appts)
Snoozes the appointments.
Parameters:
{AjxVector} appts
a list of ZmAppt objects
Returns:
{Array} an array of snoozed apt ids

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:33 GMT-0400 (EDT)