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.

API Reference

Task

The Task object represents a Task entry that would be in your PIM task list. This Task object can be used for manipulating Task PIM information.

Functions

This method finds the tasks that match the regular expression provided.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Parameters

filter

Optional expression parameter that defines the search criteria for the find. If no value is provided the method will return all the Tasks on the device.

orderBy

Optional 'orderBy' parameter specifying the field which the results will be sorted by. If 'isAscending' is not specified 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 specified or set to -1, it will return all results found.

isAscending

Optional 'isAscending' parameter specifying whether the sort order is ascending or descending. If not specified 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
()

This method will remove a Task from the PIM storage.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

void
save
()

This method will save the changes made to the Task object.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Properties

void
categories

The list of categories associated to the task.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Date
due

The due date for this task.

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

Number
priority

This specifies the priority of the task. Value can be one of the 'Priority' constants. Default value is PRIORITY_NORMAL.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Recurrence
recurrence

This is the rule to store how this task 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 task.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

Number
status

Current status of this task. Value can be one of the 'Status' constants. Default value is NOT_STARTED.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

String
summary

Contains a brief description of the task.

Supported Platforms

- BlackBerry OS 5.0+

- Ripple Emulator

readonly
String
uid

Contains the unique ID of the object. It is the primary key and would be automatically generated. This field is read-only.