CalendarFindOptions

The CalendarFindOptions object contains fields that filter and sort the results of blackberry.pim.calendar.findEvents().

Installation:

To use this API in your project, add the calendar plugin:

webworks plugin add com.blackberry.pim.calendar
Properties:
Number detail
CalendarEventFilter filter
Number limit
Object[] sort

detail

The detail level controls what attributes will be returned for each event. This should be one of the DETAIL_* constants. Defaults to CalendarFindOptions.DETAIL_AGENDA

Synopsis:

Number CalendarFindOptions.DETAIL_AGENDA

filter

A search filter with which to search and initially filter the Calendar database.

Synopsis:

CalendarEventFilter CalendarFindOptions.filter

limit

The maximum number of returned events.

Synopsis:

Number CalendarFindOptions.limit

sort

An array of object literals that specifies the order of the results.

The object should be in the following form:
  {
    fieldName: <field name, one of the SORT_FIELD_* constants>,
    desc: true to sort results in descending order
  }
    		

Synopsis:

Object[] CalendarFindOptions.sort

SORT_FIELD_SUMMARY

Used by specifying the sort field

Synopsis:

constant
Number CalendarFindOptions.SORT_FIELD_SUMMARY = 2

SORT_FIELD_LOCATION

Used by specifying the sort field

Synopsis:

constant
Number CalendarFindOptions.SORT_FIELD_LOCATION = 3

SORT_FIELD_START

Used by specifying the sort field

Synopsis:

constant
Number CalendarFindOptions.SORT_FIELD_START = 4

SORT_FIELD_END

Used by specifying the sort field

Synopsis:

constant
Number CalendarFindOptions.SORT_FIELD_END = 5

DETAIL_MONTHLY

Lowest detail level, used for monthly views. Event fields populated are: accountId, allDay, transparency, start, end, folderId, id, parentId.

Synopsis:

constant
Number CalendarFindOptions.DETAIL_MONTHLY = 1

DETAIL_WEEKLY

Detail level for weekly views. Event fields populated are those in the monthly level plus birthday and summary.

Synopsis:

constant
Number CalendarFindOptions.DETAIL_WEEKLY = 2

DETAIL_FULL

Full detail level. All fields are populated.

Synopsis:

constant
Number CalendarFindOptions.DETAIL_FULL = 3

DETAIL_AGENDA

Agenda detail level. Event fields populated are those in the monthly level plus location, status, and recurrence.

Synopsis:

constant
Number CalendarFindOptions.DETAIL_AGENDA = 4

Last modified: 2014-09-29



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus