CalendarEventFilter

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

Installation:

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

webworks plugin add com.blackberry.pim.calendar
Properties:
Date end
Boolean expandRecurring
CalendarFolder[] folders
Date start
String substring

end

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

Synopsis:

Date CalendarEventFilter.end

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 CalendarEvent.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.

Synopsis:

Boolean CalendarEventFilter.expandRecurring

folders

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

Synopsis:

CalendarFolder[] CalendarEventFilter.folders

start

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

Synopsis:

Date CalendarEventFilter.start

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.

Synopsis:

String CalendarEventFilter.substring

Last modified: 2014-10-09



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

comments powered by Disqus