# Titanium.Calendar.Alert

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

- Source: https://titaniumsdk.com/docs/sdk/12.6.3/Titanium.Calendar.Alert
- Titanium SDK version: 12.6.3
- Kind: proxy
- Platforms: Android, iPhone, iPad, macOS
- Since: Titanium SDK Android 3.2.0, iPhone 3.1.0, iPad 3.1.0
- Extends: Titanium.Proxy
- Inheritance: Titanium.Proxy

## Properties

### absoluteDate

- Type: Date
- Platforms: iPhone, iPad, macOS

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

- Type: Date
- Platforms: Android
- Permission: read-only

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

### begin

- Type: Date
- Platforms: Android
- Permission: read-only

Start date/time for the corresponding event.

### end

- Type: Date
- Platforms: Android
- Permission: read-only

End date/time for the corresponding event.

### eventId

- Type: Number
- Platforms: Android, iPhone, iPad, macOS
- Permission: read-only

Identifier of the event for which this alert is set.

### id

- Type: String
- Platforms: Android
- Permission: read-only

Identifier of this alert.

### minutes

- Type: Number
- Platforms: Android
- Permission: read-only

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

### relativeOffset

- Type: Number
- Platforms: iPhone, iPad, macOS

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

- Type: Number
- Platforms: Android
- Permission: read-only

The current state of the alert.

Accepts: `Titanium.Calendar.STATE_DISMISSED`, `Titanium.Calendar.STATE_FIRED`, `Titanium.Calendar.STATE_SCHEDULED`

## Inherited members

7 members are inherited. Each is documented on the type that declares it.

- [Titanium.Proxy](https://titaniumsdk.com/docs/sdk/12.6.3/Titanium.Proxy.md): `addEventListener`, `apiName`, `applyProperties`, `bubbleParent`, `fireEvent`, `lifecycleContainer`, `removeEventListener`

---

- This corpus documents Titanium SDK 13.4.1. Anything here that does not name a version describes 13.4.1.
- Titanium is maintained by TiDev. The Appcelerator toolchain is retired: there is no `appc` CLI, no Appcelerator Studio and no hosted build service. The supported CLI is `titanium` on npm, invoked as `ti`.