Browse the API284 types

Version12.7.0

You are reading 12.7.0. See this page in 13.4.1.

Titanium.Calendar.Alert

proxyAndroidiPhoneiPadmacOSsince Android 3.2.0, iPhone 3.1.0, iPad 3.1.0

Extends Titanium.Proxy

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

Properties 12

absoluteDate

DateiPhoneiPadmacOS

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

DateAndroidread-only

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

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

begin

DateAndroidread-only

Start date/time for the corresponding event.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

Indicates if the proxy will bubble an event to its parent.

Default: true

end

DateAndroidread-only

End date/time for the corresponding event.

eventId

Numberread-only

Identifier of the event for which this alert is set.

id

StringAndroidread-only

Identifier of this alert.

lifecycleContainer

Titanium.UI.Window | Titanium.UI.TabGroupAndroidsince 3.6.0

Inherited from Titanium.Proxy

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

minutes

NumberAndroidread-only

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

relativeOffset

NumberiPhoneiPadmacOS

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

NumberAndroidread-only

The current state of the alert.

Accepts

Methods 4

addEventListener

Inherited from Titanium.Proxy

Adds the specified callback as an event listener for the named event.

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to invoke when the event is fired. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.

applyProperties

since 3.0.0

Inherited from Titanium.Proxy

Applies the properties to the proxy.

Parameters
Parameters	Type	Description
props	Dictionary	A dictionary of properties to apply.

fireEvent

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
Parameters	Type	Description
name	String	Name of the event.
event?	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

removeEventListener

Inherited from Titanium.Proxy

Removes the specified callback as an event listener for the named event.

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.

Version12.7.0