Titanium.Android.Calendar.Event

Platform Since
Android 1.5

Summary

An object which represents a single event in an Android calendar.

Description

The API supports retrieving information about existing events and creating new events.
However, modifying or deleting existing events is not yet supported. Additionally, recurring events are not yet supported.

See Titanium.Android.Calendar for examples of retrieving event information and creating events.

Methods

Name Summary
addEventListener

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

createAlert

create an alert for this event. Pass a dictionary object containing attributes corresponding to properties of Titanium.Android.Calendar.Alert. Returns the created alert.

createReminder

create a reminder for this event. Pass a dictionary object containing attributes corresponding to properties of Titanium.Android.Calendar.Reminder. Returns the created Reminder.

fireEvent

Fires a synthesized event to any registered listeners.

getExtendedProperty

Returns the value of the given extended property key string.

removeEventListener

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

setExtendedProperty

Set the value of the named extended property.

Properties

Name Type Summary
alerts Array<Titanium.Android.Calendar.Alert>

An array of Titanium.Android.Calendar.Alert objects which are the alerts - if any - for this event. read-only

allDay Boolean

Whether the event is all day. read-only

begin Date

The date/time at which the event begins. read-only

description String

The event description. read-only

end Date

The date/time at which the event ends. read-only

extendedProperties Object

An object containing extended properties of the event. read-only

hasAlarm Boolean

Whether an alarm is scheduled for the event. read-only

hasExtendedProperties Boolean read-only
id String

The id of the event. read-only

location String

The event location. read-only

reminders Array<Titanium.Android.Calendar.Reminder>

An array of Titanium.Android.Calendar.Reminder objects which are the reminders - if any - for this event. read-only

status Number

The status of the event. Possible values are the STATUS constants in Titanium.Android.Calendar. read-only

title String

The title string for the event. read-only

visibility Number

The event's visibility. Possible values are the VISIBILITY constants in Titanium.Android.Calendar. read-only

Events

This type has no events.