Titanium.Calendar.RecurrenceRule
> Titanium.Calendar.RecurrenceRule

An object that is used to describe the recurrence pattern for a recurring event.

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

In case of having daysOfTheWeek and daysOfTheMonth for an event with a recurrence rule of type RECURRENCEFREQUENCY_MONTHLY only [daysOfTheWeek] will be used.

  • 7.1.0
  • 3.1.0
  • 3.1.0
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button returns Ti.UI.Button.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Indicates if the proxy will bubble an event to its parent. ...

Indicates 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

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium.Calendar.RecurrenceRule
calendarID : Stringreadonly

Identifier for the recurrence rule's calendar.

Identifier for the recurrence rule's calendar.

Titanium.Calendar.RecurrenceRule
: Number[]readonly
The days of the month that the event occurs, as an array of number objects. ...

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

Titanium.Calendar.RecurrenceRule
daysOfTheWeek : daysOfTheWeekDictionaryreadonly

The days of the week that the event occurs, as an Dictionay of daysOfWeek and Week.

The days of the week that the event occurs, as an Dictionay of daysOfWeek and Week.

On Android daysOfTheWeek is not valid for recurrence rules of type RECURRENCEFREQUENCY_YEARLY.

Titanium.Calendar.RecurrenceRule
: Number[]readonly
The days of the year that the event occurs, as an array of number objects. ...

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

Titanium.Calendar.RecurrenceRule
end : recurrenceEndDictionaryreadonly

End of a recurrence rule.

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

Titanium.Calendar.RecurrenceRule
: Numberreadonly
Frequency of the recurrence rule. ...
Titanium.Calendar.RecurrenceRule
: Numberreadonly
The interval between instances of this recurrence. ...

The 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

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

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

  • 3.6.0
Titanium.Calendar.RecurrenceRule
: Number[]readonly
The months of the year that the event occurs, as an array of Number objects. ...

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

Titanium.Calendar.RecurrenceRule
: Number[]readonly
An array of ordinal numbers that filters which recurrences to include in the recurrence rule's frequency. ...

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

  • 3.1.0
  • 3.1.0
Titanium.Calendar.RecurrenceRule
: Number[]readonly
The weeks of the year that the event occurs, as an array of number objects. ...

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

Defined By

Methods

Adds the specified callback as an event listener for the named event. ...

Adds the specified callback as an event listener for the named event.

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Titanium.Calendar.RecurrenceRule
( ) : String
Gets the value of the calendarID property. ...

Gets the value of the calendarID property.

Returns

  • String
Titanium.Calendar.RecurrenceRule
( ) : Number[]
Gets the value of the daysOfTheMonth property. ...

Gets the value of the daysOfTheMonth property.

Returns

  • Number[]
Titanium.Calendar.RecurrenceRule
( ) : daysOfTheWeekDictionary
Gets the value of the daysOfTheWeek property. ...

Gets the value of the daysOfTheWeek property.

Returns

Titanium.Calendar.RecurrenceRule
( ) : Number[]
Gets the value of the daysOfTheYear property. ...

Gets the value of the daysOfTheYear property.

Returns

  • Number[]
Titanium.Calendar.RecurrenceRule
( ) : recurrenceEndDictionary
Gets the value of the end property. ...

Gets the value of the end property.

Returns

Titanium.Calendar.RecurrenceRule
( ) : Number
Gets the value of the frequency property. ...

Gets the value of the frequency property.

Returns

  • Number
Titanium.Calendar.RecurrenceRule
( ) : Number
Gets the value of the interval property. ...

Gets the value of the interval property.

Returns

  • Number
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.Calendar.RecurrenceRule
( ) : Number[]
Gets the value of the monthsOfTheYear property. ...

Gets the value of the monthsOfTheYear property.

Returns

  • Number[]
Titanium.Calendar.RecurrenceRule
( ) : Number[]
Gets the value of the setPositions property. ...

Gets the value of the setPositions property.

  • 3.1.0
  • 3.1.0

Returns

  • Number[]
Titanium.Calendar.RecurrenceRule
( ) : Number[]
Gets the value of the weeksOfTheYear property. ...

Gets the value of the weeksOfTheYear property.

Returns

  • Number[]
Removes the specified callback as an event listener for the named event. ...

Removes 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 : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void