# Titanium.Calendar.Event

An object that represents a single event in a calendar.

Availability
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

Availability
3.2.0
3.1.0
9.2.0
alerts :Array<Titanium.Calendar.Alert>

Alarms associated with the calendar item, as an array of Titanium.Calendar.Alert objects.

This property is read-only on Android.


# allDay

Availability
3.2.0
3.1.0
9.2.0
allDay :Boolean

Indicates whether this event is all day.

This property is read-only on Android.

Default: false


# attendees READONLY

Availability
6.0.0
9.2.0
attendees :Array<Titanium.Calendar.Attendee>

The list of event attendees. This list will be empty if the event has no attendees.


# availability

Availability
3.1.0
9.2.0
availability :Number

Availability of this event.


# begin

Availability
3.2.0
3.1.0
9.2.0
begin :Date

Start date/time of this event.

This property is read-only on Android.


# description READONLY

Availability
3.2.0
description :String

Description of this event.


# end

Availability
3.2.0
3.1.0
9.2.0
end :Date

End date/time of this event.

This property is read-only on Android.


# extendedProperties READONLY

Availability
3.2.0
extendedProperties :Dictionary

Extended properties of this event.


# hasAlarm READONLY

Availability
3.2.0
3.1.0
9.2.0
hasAlarm :Boolean

Indicates whether an alarm is scheduled for this event.


# id READONLY

Availability
3.2.0
3.1.0
9.2.0
id :String

Identifier of this event.


# isDetached READONLY

Availability
3.1.0
9.2.0
isDetached :Boolean

Boolean 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

Availability
3.2.0
3.1.0
9.2.0
location :String

Location of this event.

This property is read-only on Android.


# notes

Availability
3.1.0
9.2.0
notes :String

Notes for this event.


# recurrenceRules

Availability
7.1.0
3.1.0
9.2.0
recurrenceRules :Array<Titanium.Calendar.RecurrenceRule>

The 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

Availability
3.2.0
reminders :Array<Titanium.Calendar.Reminder>

Existing reminders for this event.


# status READONLY

Availability
3.2.0
3.1.0
9.2.0
status :Number

Status of this event.


# title

Availability
3.2.0
3.1.0
9.2.0
title :String

Title of this event.

This property is read-only on Android.


# visibility READONLY

Availability
3.2.0
visibility :Number

Visibility of this event.

# Methods

# addRecurrenceRule

Availability
3.1.0
9.2.0
addRecurrenceRule(rule) void

Adds 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

Availability
3.2.0
3.1.0
9.2.0
createAlert(data) Titanium.Calendar.Alert

Creates an alert for this event.

Parameters

Name Type Description
data Dictionary<Titanium.Calendar.Alert>

Properties for the alert.

Returns


# createRecurrenceRule

Availability
7.1.0
3.1.0
9.2.0
createRecurrenceRule(data) Titanium.Calendar.RecurrenceRule

Creates 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

Availability
3.2.0
createReminder(data) Titanium.Calendar.Reminder

Creates a reminder for this event.

Parameters

Name Type Description
data Dictionary<Titanium.Calendar.Reminder>

Properties for the reminder.

Returns


# getExtendedProperty

Availability
3.2.0
getExtendedProperty(name) String

Gets the value of the specified extended property.

Parameters

Name Type Description
name String

Name of an existing extended property.

Returns

Type
String

# refresh

Availability
3.1.0
9.2.0
refresh() Boolean

Updates 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

Availability
3.1.0
9.2.0
remove(span) Boolean

Removes 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

Availability
3.1.0
9.2.0
removeRecurrenceRule(rule) void

Removes 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

Availability
7.1.0
3.1.0
9.2.0
save(span) Boolean

Saves 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

Availability
3.2.0
setExtendedProperty(name, value) void

Sets the value of the specified extended property.

Parameters

Name Type Description
name String

Property name.

value String

Property value.

Returns

Type
void