CalendarFindOptions
The CalendarFindOptions object contains fields that filter and sort the results of blackberry.pim.calendar.findEvents().
Supported Platform(s)
| - BlackBerry 10 |
| API | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
|---|---|---|---|---|---|---|---|
| detail | Y | ||||||
| filter | Y | ||||||
| limit | Y | ||||||
| sort | Y | ||||||
| SORT_FIELD_SUMMARY | Y | ||||||
| SORT_FIELD_LOCATION | Y | ||||||
| SORT_FIELD_START | Y | ||||||
| SORT_FIELD_END | Y | ||||||
| DETAIL_MONTHLY | Y | ||||||
| DETAIL_WEEKLY | Y | ||||||
| DETAIL_FULL | Y | ||||||
| DETAIL_AGENDA | 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 | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
|---|---|---|---|---|---|---|---|
| <feature id="blackberry.pim.calendar" /> | Y |
| Permission Elements (PlayBook and BlackBerry 10+) |
|---|
| This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application. |
Properties
| Number | detail |
| blackberry.pim.calendar.CalenderEventFilter | filter |
| Number | limit |
| Object[] | sort |
Constants
| Number | SORT_FIELD_SUMMARY |
| Number | SORT_FIELD_LOCATION |
| Number | SORT_FIELD_START |
| Number | SORT_FIELD_END |
| Number | DETAIL_MONTHLY |
| Number | DETAIL_WEEKLY |
| Number | DETAIL_FULL |
| Number | DETAIL_AGENDA |
Properties
Number
detail
The detail level controls what attributes will be returned for each event. This should be one of the DETAIL_* constants. Defaults to DETAIL_AGENDA
| Supported Platforms | |
|---|---|
| - BlackBerry 10 | |
blackberry.pim.calendar.CalenderEventFilter
filter
A search filter with which to search and initially filter the Calendar database.
| Supported Platforms | |
|---|---|
| - BlackBerry 10 | |
Constants
static
Number
SORT_FIELD_SUMMARY
Used by specifying the sort field
| Supported Platforms | |
|---|---|
| - BlackBerry 10 | |
static
Number
SORT_FIELD_LOCATION
Used by specifying the sort field
| Supported Platforms | |
|---|---|
| - BlackBerry 10 | |
static
Number
SORT_FIELD_START
Used by specifying the sort field
| Supported Platforms | |
|---|---|
| - BlackBerry 10 | |
static
Number
DETAIL_MONTHLY
Lowest detail level, used for monthly views. Event fields populated are: accountId, allDay, transparency, start, end, folderId, id, parentId.
| Supported Platforms | |
|---|---|
| - BlackBerry 10 | |
static
Number
DETAIL_WEEKLY
Detail level for weekly views. Event fields populated are those in the monthly level plus birthday and summary.
| Supported Platforms | |
|---|---|
| - BlackBerry 10 | |