Titanium SDK

# Titanium.Android.PendingIntent

The Titanium binding of an Android PendingIntent.

Availability
1.5
Extends
Titanium.Proxy

# Overview

Use the Titanium.Android.createPendingIntent method to create a pending intent.

The type of Intent you pass to createPendingIntent determines what kind of PendingIntent is created. Each type corresponds directly with a get method on Android's PendingIntent:

  • To create a PendingIntent that starts an activity, pass in an activity intent, created with Titanium.Android.createIntent. This is equivalent to calling the native Android PendingIntent.getActivity method. See [PendingIntent.getActivity in the Android API Reference](https://developer.android.com/reference/android/app/PendingIntent.html#getActivity(android.content.Context, int, android.content.Intent, int))

  • To create a PendingIntent that starts a service, pass in a service intent, created with Titanium.Android.createServiceIntent. This is equivalent to calling the native Android PendingIntent.getService method. See [PendingIntent.getService in the Android API Reference](https://developer.android.com/reference/android/app/PendingIntent.html#getService(android.content.Context, int, android.content.Intent, int)).

The PendingIntent is always associated with the activity that was the current activity when the intent was created.

Note that this PendingIntent is designed primarily to be used with the Titanium.Android.Notification object. It does not support all features of the native Android PendingIntent -- in particular, broadcast pending intents are not supported.

See also:

# Properties

# apiName READONLY

Availability
3.2.0
apiName :String

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, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability
3.0.0
bubbleParent :Boolean

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

# flags CREATION ONLY

Availability
1.5
flags :Number

Flags used for creating the Pending Intent.

This API can be assigned the following constants:

# intent CREATION ONLY

Availability
1.5
intent :Titanium.Android.Intent

The intent data to pass to the Titanium.Android.Activity launched by this PendingIntent.

# lifecycleContainer

Availability
3.6.0
lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

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.

# updateCurrentIntent CREATION ONLY

Availability
1.5
updateCurrentIntent :Boolean

If this property is true, flag FLAG_UPDATE_CURRENT will be appended to flags automatically. Default value is true.

# Methods

# addEventListener

Availability
1.5
addEventListener(name, callback) → void

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

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# applyProperties

Availability
3.0.0
applyProperties(props) → void

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.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# fireEvent

Availability
1.5
fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

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

Returns

Type
void

# removeEventListener

Availability
1.5
removeEventListener(name, callback) → void

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 Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

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

Returns

Type
void

Contents