# Titanium.Calendar.Calendar

An object that represents a single calendar.

Availability

3.2.0

3.1.0

9.2.0

Extends

Titanium.Proxy

# Properties

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

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

# sourceType READONLY

Availability

6.1.0

9.2.0

sourceType :Number

Displays the source type.

This API can be assigned the following constants:

# Methods

# 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

Type: Titanium.Calendar.Event

# 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

Type: Titanium.Calendar.Event

# 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

Type: Array<Titanium.Calendar.Event>

# 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

Type: Array<Titanium.Calendar.Event>

# 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

Type: Array<Titanium.Calendar.Event>

# 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

Type: Array<Titanium.Calendar.Event>