Titanium.Android.Calendar.Event
> Titanium.Android.Calendar.Event

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

deprecated since 3.2.0

The API supports retrieving information about existing events and creating new events.
Be aware that 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.

  • 1.5
Defined By

Properties

Titanium.Android.Calendar.Event
alerts : Titanium.Android.Calendar.Alert[]readonly

Existing alerts for this event.

Existing alerts for this event.

Titanium.Android.Calendar.Event
allDay : Booleanreadonly

Indicates whether this event is all day.

Indicates whether this event is all day.

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button returns Ti.UI.Button.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Titanium.Android.Calendar.Event
begin : Datereadonly

Start date/time of this event.

Start date/time of this event.

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

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

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium.Android.Calendar.Event
description : Stringreadonly

Description of this event.

Description of this event.

Titanium.Android.Calendar.Event
end : Datereadonly

End date/time of this event.

End date/time of this event.

Titanium.Android.Calendar.Event
extendedProperties : Dictionaryreadonly

Extended properties of this event.

Extended properties of this event.

Titanium.Android.Calendar.Event
hasAlarm : Booleanreadonly

Indicates whether an alarm is scheduled for this event.

Indicates whether an alarm is scheduled for this event.

Titanium.Android.Calendar.Event
hasExtendedProperties : Booleanreadonly

Indicates whether extendedProperties exists for this event.

Indicates whether extendedProperties exists for this event.

Titanium.Android.Calendar.Event
id : Stringreadonly

Identifier of this event.

Identifier of this event.

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

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

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

  • 3.6.0
Titanium.Android.Calendar.Event
location : Stringreadonly

Location of this event.

Location of this event.

Titanium.Android.Calendar.Event
reminders : Titanium.Android.Calendar.Reminder[]readonly

Existing reminders for this event.

Existing reminders for this event.

Titanium.Android.Calendar.Event
status : Numberreadonly

Status of this event.

Status of this event.

One of STATUS_CANCELED, STATUS_CONFIRMED, and STATUS_TENTATIVE.

Titanium.Android.Calendar.Event
title : Stringreadonly

Title of this event.

Title of this event.

Titanium.Android.Calendar.Event
visibility : Numberreadonly

Visibility of this event.

Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Titanium.Android.Calendar.Event
( data ) : Titanium.Android.Calendar.Alert
Creates an alert for this event. ...

Creates an alert for this event.

Parameters

Returns

Titanium.Android.Calendar.Event
( data ) : Titanium.Android.Calendar.Reminder
Creates a reminder for this event. ...

Creates a reminder for this event.

Parameters

Returns

Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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.

Returns

  • void
Titanium.Android.Calendar.Event
( ) : Titanium.Android.Calendar.Alert[]
Gets the value of the alerts property. ...

Gets the value of the alerts property.

Returns

Titanium.Android.Calendar.Event
( ) : Boolean
Gets the value of the allDay property. ...

Gets the value of the allDay property.

Returns

  • Boolean
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Titanium.Android.Calendar.Event
( ) : Date
Gets the value of the begin property. ...

Gets the value of the begin property.

Returns

  • Date
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Titanium.Android.Calendar.Event
( ) : String
Gets the value of the description property. ...

Gets the value of the description property.

Returns

  • String
Titanium.Android.Calendar.Event
( ) : Date
Gets the value of the end property. ...

Gets the value of the end property.

Returns

  • Date
Titanium.Android.Calendar.Event
( ) : Dictionary
Gets the value of the extendedProperties property. ...

Gets the value of the extendedProperties property.

Returns

Titanium.Android.Calendar.Event
( name ) : String
Gets the value of the specified extended property. ...

Gets the value of the specified extended property.

Parameters

  • name : String

    Name of an existing extended property.

Returns

  • String
Titanium.Android.Calendar.Event
( ) : Boolean
Gets the value of the hasAlarm property. ...

Gets the value of the hasAlarm property.

Returns

  • Boolean
Titanium.Android.Calendar.Event
( ) : Boolean
Gets the value of the hasExtendedProperties property. ...

Gets the value of the hasExtendedProperties property.

Returns

  • Boolean
Titanium.Android.Calendar.Event
( ) : String
Gets the value of the id property. ...

Gets the value of the id property.

Returns

  • String
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.Android.Calendar.Event
( ) : String
Gets the value of the location property. ...

Gets the value of the location property.

Returns

  • String
Titanium.Android.Calendar.Event
( ) : Titanium.Android.Calendar.Reminder[]
Gets the value of the reminders property. ...

Gets the value of the reminders property.

Returns

Titanium.Android.Calendar.Event
( ) : Number
Gets the value of the status property. ...

Gets the value of the status property.

Returns

  • Number
Titanium.Android.Calendar.Event
( ) : String
Gets the value of the title property. ...

Gets the value of the title property.

Returns

  • String
Titanium.Android.Calendar.Event
( ) : Number
Gets the value of the visibility property. ...

Gets the value of the visibility property.

Returns

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

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

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Titanium.Android.Calendar.Event
( name, value )
Sets the value of the specified extended property. ...

Sets the value of the specified extended property.

Parameters

  • name : String

    Property name.

  • value : String

    Property value.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void