new Reminder(propertiesOrQty, unit)
Class that represents a Reminder used when creating a Task. The reminder
will go off at {propertiesOrQty} {units} before the date set for the Task. Or at the
specified {propertiesOrQty.trigger}.
Parameters:
| Name |
Type |
Description |
propertiesOrQty |
Object
|
Number
|
Properties of the Reminder or the quantity of
time before the start date in which the reminder will trigger
Properties
| Name |
Type |
Attributes |
Description |
id |
string
|
<optional>
|
Object ID of the Reminder, only defined when this is an
instantiation of a pre-existing reminder. On new reminders this must be empty in order
to generate a new ObjectID |
trigger |
string
|
<optional>
|
Custom trigger in the pre-defined format
/^TRIGGER:-?PT[0-9]+[SMHD]$/ |
|
unit |
Reminder.TimeUnit
|
Unit of time |
- Source:
Members
(static, readonly) TimeUnit :Number
Enum for the time unit used in the creation of a reminder
Type:
Properties:
| Name |
Type |
Description |
SECONDS |
Number
|
Used when the reminder is set in seconds |
MINUTES |
Number
|
Used when the reminder is set in minutes |
HOURS |
Number
|
Used when the reminder is set in hours |
DAYS |
Number
|
Used when the reminder is set in days |
- Source: