Appointment

The Appointment object represents an appointment in your calendar.

Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator

View Supported Platform Table

APIOS 5.0OS 6.0OS 7.0PlayBookRipple
blackberry.pim.Appointment Y Y Y  Y
find Y Y Y  Y
remove Y Y Y  Y
save Y Y Y  Y
allDay Y Y Y  Y
attendees Y Y Y  Y
end Y Y Y  Y
freeBusy Y Y Y  Y
location Y Y Y  Y
note Y Y Y  Y
recurrence Y Y Y  Y
reminder Y Y Y  Y
start Y Y Y  Y
summary Y Y Y  Y
uid Y Y Y  Y
FREE Y Y Y  Y
TENTATIVE Y Y Y  Y
BUSY Y Y Y  Y
OUT_OF_OFFICE 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 IDOS 5.0OS 6.0OS 7.0PlayBookRipple
<feature id="blackberry.pim.Appointment" /> Y Y Y  Y
<feature id="blackberry.pim.Attendee" /> Y Y Y  Y
<feature id="blackberry.pim.Recurrence" /> Y Y Y  Y
<feature id="blackberry.pim.Reminder" /> Y Y Y  Y
<feature id="blackberry.find" /> 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.

blackberry.pim.Appointment

blackberry.pim.Appointment ([service: Service])

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

This Appointment object can be used for manipulating calendar appointments. The Appointment object is an instance object, where if a new instance is desired, it must be created using the new keyword.



Parameter Type Description
service Service
Optional 		Optional parameter specifying which service to create this appointment for. If not provided, the default device service is used.

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 = blackberry.pim.Appointment.FREE;

  // Create our hour time slot
  var start = new Date();
  newAppt.start = start;
  var end = start.setHours(start.getHours() + 1);
  newAppt.end = end;

  // Create Attendee
  var attendees = [];
  var onlyAttendee = new blackberry.pim.Attendee();
  onlyAttendee.address = "john@foo.com";
  onlyAttendee.type = blackberry.pim.Attendee.INVITED;
  attendees.push(onlyAttendee);

  newAppt.attendees = attendees;
  newAppt.save();
</script>

find

static Appointment[] find([filter: FilterExpression], [orderBy: String], [maxReturn: Number], [service: Service], [isAscending: Boolean])

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

Looks up the appointments that match the regular expression provided.



Parameter Type Description
filter FilterExpression
Optional 		optional parameter that defines the search criteria for the find. If no value is provided, the method will return all the appointments on the device.
orderBy String
Optional 		optional 'orderBy' parameter specifying the field which the results will be sorted by. If 'isAscending' is not supplied or 'isAscending' is true, the sort results will be in an ascending order. If 'isAscending' is false, the sort results will be in a descending order.
maxReturn Number
Optional 		optional integer parameter specifying the maximum number of results to return from the find. If not supplied or set to -1, it will return all results found.
service Service
Optional 		optional parameter to define which service you wish to search for your appointments. If not provided the default service for appointments will be used.
isAscending Boolean
Optional 		optional 'isAscending' parameter specifying whether the sort order is ascending or descending. If not supplied or set to true, the results sorted by the field specified by 'orderBy' will be in an ascending order. If set to false, the sort results will be in a descending order. If no 'orderBy' value is specified, 'isAscending' is neglected.

remove

void remove()

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

Removes an event from the PIM storage.


save

void save()

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

Saves the changes made to the Appointment object.


Properties:

Property Type Description Supported Platform(s)
allDay Boolean Boolean field denoting whether the appointment is an all day event.
 - BlackBerry OS 5.0+
 - Ripple Emulator
attendees Attendee The list of attendees that will be invited to this appointment.
 - BlackBerry OS 5.0+
 - Ripple Emulator
end Date The end date for this appointment.
 - BlackBerry OS 5.0+
 - Ripple Emulator
freeBusy Number The free/busy status for the appointment. Value can be one of the FreeBusy options.
 - BlackBerry OS 5.0+
 - Ripple Emulator
location String Holds the location information for this appointment, for example, a meeting room name.
 - BlackBerry OS 5.0+
 - Ripple Emulator
note String Contains a more complete description than the summary field.
 - BlackBerry OS 5.0+
 - Ripple Emulator
recurrence Recurrence This is the rule to store how this appointment should be repeated if any.
 - BlackBerry OS 5.0+
 - Ripple Emulator
reminder Reminder This is the rule to store how the user should be reminded about the appointment.
 - BlackBerry OS 5.0+
 - Ripple Emulator
start Date The start date for this appointment.
 - BlackBerry OS 5.0+
 - Ripple Emulator
summary String Contains a brief description of the appointment.
 - BlackBerry OS 5.0+
 - Ripple Emulator
uid String
readonly 		Represents the unique ID of the appointment.
 - BlackBerry OS 5.0+
 - Ripple Emulator

Constants:

Property Type Description Supported Platform(s)
FREE Number Marks time as free in calendar
 - BlackBerry OS 5.0+
 - Ripple Emulator
TENTATIVE Number Mark time as tentative in calendar
 - BlackBerry OS 5.0+
 - Ripple Emulator
BUSY Number Mark time as busy in calendar
 - BlackBerry OS 5.0+
 - Ripple Emulator
OUT_OF_OFFICE Number Mark time as out of office in calendar
 - BlackBerry OS 5.0+
 - Ripple Emulator
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:15 GMT-0500 (EST)