# Titanium.Calendar.Calendar

An object that represents a single calendar.

Availability
3.2.0
3.1.0
9.2.0

# Properties

# apiName READONLY

Availability
3.2.0
3.2.0
9.2.0
apiName :String

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, Titanium.UI.Button returns Ti.UI.Button.


# bubbleParent

Availability
3.2.0
3.1.0
9.2.0
bubbleParent :Boolean

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


# hidden READONLY

Availability
3.2.0
3.1.0
9.2.0
hidden :Boolean

Indicates whether this calendar can be edited or deleted.

This property is true when this calendar is editable.


# id READONLY

Availability
3.2.0
3.1.0
9.2.0
id :String

Identifier of this calendar.


# lifecycleContainer

Availability
3.6.0

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.


# name READONLY

Availability
3.2.0
3.1.0
9.2.0
name :String

Display name of this calendar.


# selected READONLY

Availability
3.2.0
selected :Boolean

Indicates whether the calendar is selected.

Set to true when this calendar is selected.

See Titanium.Calendar for examples.


# sourceIdentifier READONLY

Availability
6.1.0
9.2.0
sourceIdentifier :String

Displays the source identifier.


# sourceTitle READONLY

Availability
6.1.0
9.2.0
sourceTitle :String

Displays the source title.


# Methods

# addEventListener

Availability
3.2.0
3.1.0
9.2.0
addEventListener(name, callback) void

Adds 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

Availability
3.2.0
3.1.0
9.2.0
applyProperties(props) void

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.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# createEvent

Availability
3.2.0
3.1.0
9.2.0
createEvent(properties) Titanium.Calendar.Event

Creates an event in this calendar.

Parameters

Name Type Description
properties Dictionary<Titanium.Calendar.Event>

Properties of the event

Returns


# createEvents

Availability
12.6.0
createEvents(propertiesArray) Array<Titanium.Calendar.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

Name Type Description
propertiesArray Array<Dictionary<Titanium.Calendar.Event>>

Array of the event properties

Returns


# deleteEvents

Availability
12.6.0
deleteEvents(ids) Number

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

Name Type Description
ids Array<Number> | Array<String>

Array of identifiers of events.

Returns

Count of successfully deleted events.

Type
Number

# fireEvent

Availability
3.2.0
3.1.0
9.2.0
fireEvent(name[, event]) void

Fires 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

# getEventById

Availability
3.2.0
3.1.0
9.2.0
getEventById(id) Titanium.Calendar.Event

Gets the event with the specified identifier.

Parameters

Name Type Description
id String

Identifier of the event.

Returns


# getEventsBetweenDates

Availability
3.2.0
3.1.0
9.2.0
getEventsBetweenDates(date1, date2) Array<Titanium.Calendar.Event>

Gets events that occur between two dates.

Parameters

Name Type Description
date1 Date | String

Start date.

date2 Date | String

End date.

Returns


# getEventsById

Availability
12.6.0
getEventsById(ids) Array<Titanium.Calendar.Event>

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

Name Type Description
ids Array<Number> | Array<String>

Array of identifiers of events.

Returns


# getEventsInDate DEPRECATED

Availability
3.2.0
3.1.0
9.2.0
getEventsInDate(year, month, day) Array<Titanium.Calendar.Event>

DEPRECATED SINCE 7.0.0

Use getEventsBetweenDates instead.

Gets events that occur on a specified date.

Parameters

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

Returns


# getEventsInMonth DEPRECATED

Availability
3.2.0
3.1.0
9.2.0
getEventsInMonth(year, month) Array<Titanium.Calendar.Event>

DEPRECATED SINCE 7.0.0

Use getEventsBetweenDates instead.

Gets events that occur during a specified month.

Parameters

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

Returns


# getEventsInYear DEPRECATED

Availability
3.2.0
3.1.0
9.2.0
getEventsInYear(year) Array<Titanium.Calendar.Event>

DEPRECATED SINCE 7.0.0

Use getEventsBetweenDates instead.

Gets all events that occur during a specified year.

Parameters

Name Type Description
year Number

Year of the events.

Returns


# removeEventListener

Availability
3.2.0
3.1.0
9.2.0
removeEventListener(name, callback) void

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 Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

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

Returns

Type
void