| Platform | Since |
|---|---|
| Android | 1.5 |
An object which represents a single event in an Android calendar.
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.
| 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 |
| createReminder |
create a reminder for this event. Pass a dictionary object containing attributes corresponding to properties of |
| fireEvent |
Fires a synthesized event to any registered listeners. |
| getAlerts |
Gets the value of the alerts property. |
| getAllDay |
Gets the value of the allDay property. |
| getBegin |
Gets the value of the begin property. |
| getDescription |
Gets the value of the description property. |
| getEnd |
Gets the value of the end property. |
| getExtendedProperties |
Gets the value of the extendedProperties property. |
| getExtendedProperty |
Returns the value of the given extended property key string. |
| getHasAlarm |
Gets the value of the hasAlarm property. |
| getHasExtendedProperties |
Gets the value of the hasExtendedProperties property. |
| getId |
Gets the value of the id property. |
| getLocation |
Gets the value of the location property. |
| getReminders |
Gets the value of the reminders property. |
| getStatus |
Gets the value of the status property. |
| getTitle |
Gets the value of the title property. |
| getVisibility |
Gets the value of the visibility property. |
| removeEventListener |
Removes the specified callback as an event listener for the named event. |
| setExtendedProperty |
Set the value of the named extended property. |
| Name | Type | Summary |
|---|---|---|
| alerts | Array<Titanium.Android.Calendar.Alert> |
An array of |
| 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 |
| status | Number |
The status of the event. Possible values are the STATUS constants in |
| title | String |
The title string for the event. read-only |
| visibility | Number |
The event's visibility. Possible values are the VISIBILITY constants in |
