Titanium.Android.PendingIntent
The Titanium binding of an Android PendingIntent.
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
PendingIntentthat starts an activity, pass in an activity intent, created with createIntent. This is equivalent to calling the native AndroidPendingIntent.getActivitymethod. 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
PendingIntentthat starts a service, pass in a service intent, created with createServiceIntent. This is equivalent to calling the native AndroidPendingIntent.getServicemethod. 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 Notification object. It does not support all features of the native Android PendingIntent -- in particular, broadcast pending intents are not supported.
See also:
Extends: Titanium.Proxy · Since: 1.5 · Platforms: android
Properties #
apiName#
Type: 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, Button
returns Ti.UI.Button.
bubbleParent#
Type: 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.
intent#
Type: Titanium.Android.Intent
The intent data to pass to the Activity launched by this PendingIntent.
lifecycleContainer#
Type: 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#
Type: Boolean
If this property is true, flag Titanium.Android.FLAG_UPDATE_CURRENT will be
appended to flags automatically. Default value is true.
Methods #
addEventListener #
Adds the specified callback as an event listener for the named event.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. | No |
applyProperties #
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.
| Name | Type | Summary | Optional |
|---|---|---|---|
props | Dictionary | A dictionary of properties to apply. | No |
fireEvent #
Fires a synthesized event to any registered listeners.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. | Yes |
removeEventListener #
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);
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to addEventListener. | No |