Reminder

The Reminder object is used to represent the reminder rule for an appointment or a task.

Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator

View Supported Platform Table

API	OS 5.0	OS 6.0	OS 7.0	Ripple
blackberry.pim.Reminder	Y	Y	Y	Y
date	Y	Y	Y	Y
relativeHours	Y	Y	Y	Y
type	Y	Y	Y	Y
DATE	Y	Y	Y	Y
RELATIVE	Y	Y	Y	Y

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	OS 5.0	OS 6.0	OS 7.0	PlayBook	Ripple
<feature id="blackberry.pim.Reminder" />	Y	Y	Y		Y

Permission Elements (PlayBook Only)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

API Summary

Constructors

blackberry.pim.Reminder

Properties

Constants

blackberry.pim.Reminder

blackberry.pim.Reminder ()

Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator

Description

The Reminder object is an instance object, where if a new instance is desired, it must be created using the new keyword.

Code Example(s)

<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:

Property	Type	Description	Supported Platform(s)
date	Date	Specifies the exact date when the reminder will fire. This is only valid for a type of By Date(0).	- BlackBerry OS 5.0+ - Ripple Emulator
relativeHours	Number	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).	- BlackBerry OS 5.0+ - Ripple Emulator
type	Number	What type of reminder it is, possible values:\n0 - By Date\n1 - Relative.	- BlackBerry OS 5.0+ - Ripple Emulator

Constants:

Property	Type	Description	Supported Platform(s)
DATE	Number	Indicates that this reminder is set by date	- BlackBerry OS 5.0+ - Ripple Emulator
RELATIVE	Number	Indicates that this reminder is set by relative time to the appointment or task.	- BlackBerry OS 5.0+ - Ripple Emulator

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:19 GMT-0500 (EST)