Titanium Mobile

# Titanium.Calendar.Alert

An object that represents a single alert for an event in an calendar.

Availability
3.2.0
3.1.0
9.2.0
Extends
Titanium.Proxy

# Properties

# absoluteDate

Availability
3.1.0
9.2.0
absoluteDate :Date

The absolute date for the alarm.

If you set this property for a relative offset alarm, it loses the relative offset and becomes an absolute alarm.

# alarmTime READONLY

Availability
3.2.0
alarmTime :Date

Date/time at which this alert alarm is set to trigger.

# begin READONLY

Availability
3.2.0
begin :Date

Start date/time for the corresponding event.

# end READONLY

Availability
3.2.0
end :Date

End date/time for the corresponding event.

# eventId READONLY

Availability
3.2.0
3.1.0
9.2.0
eventId :Number

Identifier of the event for which this alert is set.

# id READONLY

Availability
3.2.0
id :String

Identifier of this alert.

# minutes READONLY

Availability
3.2.0
minutes :Number

Reminder notice period in minutes, that determines how long prior to the event this alert should trigger.

# relativeOffset

Availability
3.1.0
9.2.0
relativeOffset :Number

The offset from the start of an event, at which the alarm fires.

If you set this value for an absolute alarm, it loses its absolute date and becomes a relative offset alarm.

# state READONLY

Availability
3.2.0
state :Number

The current state of the alert.

This API can be assigned the following constants:

Contents