Sorry about the red box, but we really need you to update your browser. Read this excellent article if you're wondering why we are no longer supporting this browser version. Go to Browse Happy for browser suggestions and how to update.

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

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

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

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

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.

void
remove
()

Removes an event from the PIM storage.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

void
save
()

Saves the changes made to the Appointment object.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Properties

Boolean
allDay

Boolean field denoting whether the appointment is an all day event.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Attendee
attendees

The list of attendees that will be invited to this appointment.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Date
end

The end date for this appointment.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Number
freeBusy

The free&sol;busy status for the appointment. Value can be one of the FreeBusy options.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

String
location

Holds the location information for this appointment, for example, a meeting room name.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

String
note

Contains a more complete description than the summary field.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Recurrence
recurrence

This is the rule to store how this appointment should be repeated if any.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Reminder
reminder

This is the rule to store how the user should be reminded about the appointment.