Titanium SDK # 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
# apiName READONLY
7.1.0 3.2.0 9.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
7.1.0 3.1.0 9.2.0Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
# 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
# lifecycleContainer
7.1.0The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
# 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.
# Methods
# addEventListener
7.1.0 3.1.0 9.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
7.1.0 3.1.0 9.2.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
7.1.0 3.1.0 9.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# removeEventListener
7.1.0 3.1.0 9.2.0Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void