CalendarEventFilter

The CalenderEventFilter object captures the searchable parameters for finding calendar event items.


Supported Platform(s)

- BlackBerry 10
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
end           Y 
expandRecurring           Y 
folders           Y 
start           Y 
substring           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 IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<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

Date end


End of the query's time range. Any event that crosses the range should be returned.


Supported Platforms
 - BlackBerry 10

Boolean expandRecurring


If true, recurring events will be expanded in search results. This means all occurrences within a recurring event happening in the time range will be returned.
NOTE: The main use case for setting this flag to true is to remove an occurrence in a recurring event, see remove(). For any other operations to the recurring event (e.g. changing fields' values), make sure you obtain the event object by either calling blackberry.pim.calendar.getEvent() or blackberry.pim.calendar.findEvents() with the expandRecurring flag set to false.


Supported Platforms
 - BlackBerry 10

blackberry.pim.calendar.CalendarFolder[] folders


When folders are specified, only events that belong to these folders are returned.


Supported Platforms
 - BlackBerry 10

Date start


Start of the query's time range. All events that enter the range should be returned.


Supported Platforms
 - BlackBerry 10

String substring


Substring used in the search. By setting the substring, the user instructs the backend to return only events whose summary, location, or attendees' names or emails fields contain the specified value.


Supported Platforms
 - BlackBerry 10

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:03 GMT-0500 (EST)