Titanium Mobile # Titanium.Calendar.RecurrenceRule
An object that is used to describe the recurrence pattern for a recurring event.
7.1.0
3.1.0
9.2.0# Overview
On Android there is no option to have multiple recurrence rules set for the same event. Android always uses only the first element in the array passed to Titanium.Calendar.Event.recurrenceRules.
In case of having Titanium.Calendar.RecurrenceRule.daysOfTheWeek and Titanium.Calendar.RecurrenceRule.daysOfTheWeek for an event with a recurrence rule of type Titanium.Calendar.RECURRENCEFREQUENCY_MONTHLY only [daysOfTheWeek] will be used.
# Properties
# calendarID READONLY
7.1.0 3.1.0 9.2.0Identifier for the recurrence rule's calendar.
# daysOfTheMonth READONLY
7.1.0 3.1.0 9.2.0The days of the month that the event occurs, as an array of number objects. Values can be from 1 to 31 and from -1 to -31. This parameter is only valid for recurrence rules of type RECURRENCEFREQUENCY_MONTHLY.
# daysOfTheWeek READONLY
7.1.0 3.1.0 9.2.0The days of the week that the event occurs, as an array of objects daysOfWeek and Week.
On Android daysOfTheWeek is not valid for recurrence rules of type RECURRENCEFREQUENCY_YEARLY.
# daysOfTheYear READONLY
7.1.0 3.1.0 9.2.0The days of the year that the event occurs, as an array of number objects. Values can be from 1 to 366 and from -1 to -366. This parameter is only valid for recurrence rules of type RECURRENCEFREQUENCY_YEARLY.
# end READONLY
7.1.0 3.1.0 9.2.0End of a recurrence rule.
The recurrence end can be specified by a date (date-based) or by a maximum count
of occurrences (count-based). An event which is set to never end should not
have its recurrenceEnd set. EitherendDateoroccurrenceCount` property will be
present.
# frequency READONLY
7.1.0 3.1.0 9.2.0Frequency of the recurrence rule.
# interval READONLY
7.1.0 3.1.0 9.2.0The interval between instances of this recurrence. For example, a weekly recurrence rule with an interval of 2 occurs every other week. Must be greater than 0.
Default: 1
# monthsOfTheYear READONLY
7.1.0 3.1.0 9.2.0The months of the year that the event occurs, as an array of Number objects. Values can be from 1 to 12. This parameter is only valid for recurrence rules of type RECURRENCEFREQUENCY_YEARLY.
# setPositions READONLY
3.1.0 9.2.0An array of ordinal numbers that filters which recurrences to include in the
recurrence rule's frequency. For example, a yearly recurrence rule that has a
daysOfTheWeek value that specifies
Monday through Friday, and a setPositions array containing 2 and -1, occurs only
on the second weekday and last weekday of every year.
# weeksOfTheYear READONLY
7.1.0 3.1.0 9.2.0The weeks of the year that the event occurs, as an array of number objects. Values can be from 1 to 53 and from -1 to -53. This parameter is only valid for recurrence rules of type RECURRENCEFREQUENCY_YEARLY.