You are reading 13.3.1. See this page in 13.4.1.
Titanium.Calendar.Calendar
Extends Titanium.Proxy
An object that represents a single calendar.
Properties 10
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
Identifier of this calendar.
Inherited from Titanium.Proxy
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
Display name of this calendar.
Indicates whether the calendar is selected.
Set to true when this calendar is selected.
See Titanium.Calendar for examples.
Displays the source identifier.
Displays the source title.
Displays the source type.
Methods 13
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Creates an event in this calendar.
| Parameters | Type | Description |
|---|---|---|
| properties | Dictionary<Titanium.Calendar.Event> | Properties of the event |
Creates multiple events at once in this calendar.
Use this method to bulk-create events for faster performance.
Successful or failed results are returned at the same position as passed in the parameters list.
For failed events, it will return null and Titanium.Calendar.Event for successful events.
| Parameters | Type | Description |
|---|---|---|
| propertiesArray | Array<Dictionary<Titanium.Calendar.Event>> | Array of the event properties |
Deletes multiple events with their specified identifier(s).
Use this method to bulk-delete events for faster performance.
This method only returns the count of successfully deleted events.
If it is important for apps to know whether the event was deleted or not,
either use the remove() method, or
a single identifier that is passed as an array to this method.
If a specified identifier event does not exist, it will not be treated as a count,
so the count range can be in 0 <= count <= ids.length.
| Parameters | Type | Description |
|---|---|---|
| ids | Array<Number> | Array<String> | Array of identifiers of events. |
Count of successfully deleted events.
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | 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. |
Gets the event with the specified identifier.
| Parameters | Type | Description |
|---|---|---|
| id | String | Identifier of the event. |
Gets events that occur between two dates.
| Parameters | Type | Description |
|---|---|---|
| date1 | Date | String | Start date. |
| date2 | Date | String | End date. |
Gets multiple events with their specified identifier(s).
Use this method to bulk-fetch events for faster performance. Only successful events are returned, so the identifier of events should be used to compare which events were not fetched successfully.
| Parameters | Type | Description |
|---|---|---|
| ids | Array<Number> | Array<String> | Array of identifiers of events. |
getEventsInDate
deprecatedDeprecated since 7.0.0
Use Titanium.Calendar.Calendar.getEventsBetweenDates instead.
Gets events that occur on a specified date.
| Parameters | Type | Description |
|---|---|---|
| year | Number | Year of the events. |
| month | Number | Month of the events, as a zero-based integer with January at 0 and December at 11. |
| day | Number | Day of the month of the events. |
getEventsInMonth
deprecatedDeprecated since 7.0.0
Use Titanium.Calendar.Calendar.getEventsBetweenDates instead.
Gets events that occur during a specified month.
| Parameters | Type | Description |
|---|---|---|
| year | Number | Year of the events. |
| month | Number | Month of the events, as a zero-based integer with January at 0 and December at 11. |
getEventsInYear
deprecatedDeprecated since 7.0.0
Use Titanium.Calendar.Calendar.getEventsBetweenDates instead.
Gets all events that occur during a specified year.
| Parameters | Type | Description |
|---|---|---|
| year | Number | Year of the events. |
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|