Titanium.Calendar.Alert
> Titanium.Calendar.Alert

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

  • 3.2.0
  • 3.1.0
  • 3.1.0
Defined By

Properties

Titanium.Calendar.Alert
absoluteDate : Date

The absolute date for the alarm.

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.

  • 3.1.0
  • 3.1.0
Titanium.Calendar.Alert
alarmTime : Datereadonly

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

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

  • 3.2.0
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.Calendar.Alert
begin : Datereadonly

Start date/time for the corresponding event.

Start date/time for the corresponding event.

  • 3.2.0
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.Calendar.Alert
end : Datereadonly

End date/time for the corresponding event.

End date/time for the corresponding event.

  • 3.2.0
Titanium.Calendar.Alert
eventId : Numberreadonly

Identifier of the event for which this alert is set.

Identifier of the event for which this alert is set.

Titanium.Calendar.Alert
id : Stringreadonly

Identifier of this alert.

Identifier of this alert.

  • 3.2.0

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.Calendar.Alert
minutes : Numberreadonly

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

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

  • 3.2.0
Titanium.Calendar.Alert
relativeOffset : Number

The offset from the start of an event, at which the alarm fires.

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.

  • 3.1.0
  • 3.1.0
Titanium.Calendar.Alert
: Numberreadonly
The current state of the alert. ...

The current state of the alert.

This API can be assigned the following constants:

  • 3.2.0
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
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.Calendar.Alert
( ) : Date
Gets the value of the absoluteDate property. ...

Gets the value of the absoluteDate property.

  • 3.1.0
  • 3.1.0

Returns

  • Date
Titanium.Calendar.Alert
( ) : Date
Gets the value of the alarmTime property. ...

Gets the value of the alarmTime property.

  • 3.2.0

Returns

  • Date
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.Calendar.Alert
( ) : Date
Gets the value of the begin property. ...

Gets the value of the begin property.

  • 3.2.0

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.Calendar.Alert
( ) : Date
Gets the value of the end property. ...

Gets the value of the end property.

  • 3.2.0

Returns

  • Date
Titanium.Calendar.Alert
( ) : Number
Gets the value of the eventId property. ...

Gets the value of the eventId property.

Returns

  • Number
Titanium.Calendar.Alert
( ) : String
Gets the value of the id property. ...

Gets the value of the id property.

  • 3.2.0

Returns

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

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.Calendar.Alert
( ) : Number
Gets the value of the minutes property. ...

Gets the value of the minutes property.

  • 3.2.0

Returns

  • Number
Titanium.Calendar.Alert
( ) : Number
Gets the value of the relativeOffset property. ...

Gets the value of the relativeOffset property.

  • 3.1.0
  • 3.1.0

Returns

  • Number
Titanium.Calendar.Alert
( ) : Number
Gets the value of the state property. ...

Gets the value of the state property.

  • 3.2.0

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
Titanium.Calendar.Alert
( absoluteDate )
Sets the value of the absoluteDate property. ...

Sets the value of the absoluteDate property.

  • 3.1.0
  • 3.1.0

Parameters

  • absoluteDate : Date

    New value for the property.

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
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.Calendar.Alert
( relativeOffset )
Sets the value of the relativeOffset property. ...

Sets the value of the relativeOffset property.

  • 3.1.0
  • 3.1.0

Parameters

  • relativeOffset : Number

    New value for the property.

Returns

  • void