Titanium Mobile # Titanium.Calendar.Event
An object that represents a single event in a calendar.
3.2.0
3.1.0
9.2.0# Overview
The API supports retrieving information about existing events and creating new events. On iOS, existing events can be modified or deleted. On Android, only recurrence rules can be modified.
See Titanium.Calendar for examples of retrieving event information and creating events.
# Properties
# alerts
3.2.0 3.1.0 9.2.0Alarms associated with the calendar item, as an array of Titanium.Calendar.Alert objects.
This property is read-only on Android.
# allDay
3.2.0 3.1.0 9.2.0Indicates whether this event is all day.
This property is read-only on Android.
Default: false
# attendees READONLY
6.0.0 9.2.0The list of event attendees. This list will be empty if the event has no attendees.
# availability
3.1.0 9.2.0Availability of this event.
# begin
3.2.0 3.1.0 9.2.0Start date/time of this event.
This property is read-only on Android.
# end
3.2.0 3.1.0 9.2.0End date/time of this event.
This property is read-only on Android.
# extendedProperties READONLY
3.2.0Extended properties of this event.
# hasAlarm READONLY
3.2.0 3.1.0 9.2.0Indicates whether an alarm is scheduled for this event.
# isDetached READONLY
3.1.0 9.2.0Boolean value that indicates whether an event is a detached instance of a repeating event.
This value is YES if and only if the event is part of a repeating event
and one or more of its attributes have been modified from the repeating event's
default attributes.
# location
3.2.0 3.1.0 9.2.0Location of this event.
This property is read-only on Android.
# recurrenceRules
7.1.0 3.1.0 9.2.0The recurrence rules for the calendar item.
On Android, only the first element of the recurrenceRules is taken into account due to the way it handles conditions for recurrence rules.
# reminders READONLY
3.2.0Existing reminders for this event.
# status READONLY
3.2.0 3.1.0 9.2.0Status of this event.
# visibility READONLY
3.2.0Visibility of this event.
# Methods
# addRecurrenceRule
3.1.0 9.2.0Adds a recurrence rule to the recurrence rule array.
Parameters
| Name | Type | Description |
|---|---|---|
rule | Titanium.Calendar.RecurrenceRule | The recurrence rule to be added. |
Returns
- Type
- void
# createAlert
3.2.0 3.1.0 9.2.0Creates an alert for this event.
Parameters
| Name | Type | Description |
|---|---|---|
data | Dictionary<Titanium.Calendar.Alert> | Properties for the alert. |
Returns
# createRecurrenceRule
7.1.0 3.1.0 9.2.0Creates an recurrence pattern for a recurring event. All of the properties for the recurrence rule must be set during creation. The recurrence rule properties cannot be modified.
Parameters
| Name | Type | Description |
|---|---|---|
data | Dictionary<Titanium.Calendar.RecurrenceRule> | Properties for the recurrence rule. |
Returns
# createReminder
3.2.0Creates a reminder for this event.
Parameters
| Name | Type | Description |
|---|---|---|
data | Dictionary<Titanium.Calendar.Reminder> | Properties for the reminder. |
Returns
# getExtendedProperty
3.2.0Gets the value of the specified extended property.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of an existing extended property. |
Returns
- Type
- String
# refresh
3.1.0 9.2.0Updates the event's data with the current information in the Calendar database.
This method should be only used on events that your application is editing, and only when your application receives the change notification. If this method returns NO, the event has been deleted or otherwise invalidated, and you should not continue to use it.
Returns
- Type
- Boolean
# remove
3.1.0 9.2.0Removes an event from the event store.
This method raises an exception if it is passed an event from another event store.
Parameters
| Name | Type | Description |
|---|---|---|
span | Number | The span to use. Indicates whether to remove future instances of the event in the case of a recurring event. |
Returns
- Type
- Boolean
# removeRecurrenceRule
3.1.0 9.2.0Removes a recurrence rule to the recurrence rule array.
Parameters
| Name | Type | Description |
|---|---|---|
rule | Titanium.Calendar.RecurrenceRule | The recurrence rule to be removed. |
Returns
- Type
- void
# save
7.1.0 3.1.0 9.2.0Saves changes to an event permanently.
This method raises an exception if it is passed an event from another event store.
When an event is saved, it is updated in the Calendar database. Any fields you did not modify are updated to reflect the most recent value in the database. If the event has been deleted from the database, it is re-created as a new event.
On Android, this method only updates the recurrence rule (if set). See TIMOB-24248 to track this new feature.
Parameters
| Name | Type | Description |
|---|---|---|
span | Number | The span to use. Indicates whether the save affects future instances of the event in the case of a recurring event. |
Returns
- Type
- Boolean
# setExtendedProperty
3.2.0Sets the value of the specified extended property.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Property name. |
value | String | Property value. |
Returns
- Type
- void