Reminder
The Reminder object is used to represent the reminder rule for an appointment or a task.
Configuration Document Settings
To use all of the API described for this object, you must ensure the following settings are in your configuration document:
|
You must declare the feature element(s) below in your configuration document:
|
Feature ID | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
<feature id="blackberry.pim.Reminder" />
| Y |
Y |
Y |
|
|
| Y |
Permission Elements (PlayBook and BlackBerry 10+) |
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.
|
Constructors
blackberry.pim.Reminder
()
The Reminder object is an instance object, where if a new instance is desired, it must be created using the new keyword.
Supported Platforms
|
|
- BlackBerry OS 5.0+
|
|
- Ripple Emulator
|
Code Example:
<script type="text/javascript">
// Create our Event
var newAppt = new blackberry.pim.Appointment();
newAppt.location = "Your office";
newAppt.summary = "Talk about new project";
newAppt.freeBusy = 0; // Free
// Create our hour time slot
var start = new Date();
newAppt.start = start;
var end = start.setHours(start.getHours() + 1);
newAppt.end = end;
// Create Reminder
newAppt.reminder = new blackberry.pim.Reminder();
newAppt.reminder.type = blackberry.pim.Reminder.RELATIVE;
newAppt.reminder.relativeHours = 0.25; // 15 minutes
newAppt.save();
</script>
|
Properties
Date
date
Specifies the exact date when the reminder will fire. This is only valid for a type of By Date(0).
Supported Platforms
|
|
- BlackBerry OS 5.0+
|
|
- Ripple Emulator
|
Number
relativeHours
Represents the relative timing of the reminder in hours. For example 0.25 would be 15 minutes, where 24 would be the equivalent to 1 day. This is only valid for a type of Relative(1).
Supported Platforms
|
|
- BlackBerry OS 5.0+
|
|
- Ripple Emulator
|
Number
type
What type of reminder it is, possible values:\n0 - By Date\n1 - Relative.
Supported Platforms
|
|
- BlackBerry OS 5.0+
|
|
- Ripple Emulator
|
Constants
static
Number
DATE
Indicates that this reminder is set by date
Supported Platforms
|
|
- BlackBerry OS 5.0+
|
|
- Ripple Emulator
|
static
Number
RELATIVE
Indicates that this reminder is set by relative time to the appointment or task.
Supported Platforms
|
|
- BlackBerry OS 5.0+
|
|
- Ripple Emulator
|
Documentation generated by
JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:43 GMT-0500 (EST)