Message objects passed between Android application components.
In Android, applications and application components cannot directly communicate with each other. In order to communicate with another application, use an intent. An intent is a message sent to the Android OS. Android directs the message to an application or application component based on the intent's settings.
To receive an intent, an application needs to declare an Intent Filter. An intent filter indicates to the Android OS that your application can handle certain data types or URIs. For details on using Intent Filters, see the Android Intent Filters guide.
Intents can be used to start an activity, start a service or start a broadcast.
You can create either an implicit intent or an explicit intent.
An explicit intent specifies the application or application component to launch. To create an
explicit intent, specify the Intent's className
and packageName
properties to specify the
application component to launch or the url
property to specify a JavaScript file to handle
the data.
An implicit intent does not specify a particular application. Android will present the options
to the user of which applications to launch if a default application was not selected to handle
a particular data type or content URI. To create an implicit intent, do not specify the
className
, packageName
or url
properties.
Note that the parameters to create a Service Intent are different than the ones used to create an Activity or Broadcast. The properties and methods listed below are used for Activity and Broadcast Intents. See the Titanium.Android.createServiceIntent method for the parameters to create a Service Intent.
The action
property specifies the action you want the activity to perform, or in the case of
broadcasts, the action that just completed you want to report.
Titanium exposes some of the Android Intent actions as the Titanium.Android.ACTION_*
constants.
Note that some of these actions are for system-level broadcasts that only Android can send.
If Titanium has not exposed a particular constant, you can pass the string value listed in the
Android API reference guide instead.
You can also define your own custom action names. Use a reverse domain scheme to name the
action to avoid potential conflicts, for example, com.appcelerator.action.LINT
.
Custom actions are only useful to communicate between your applications and application
activities using intents.
The data property specifies a content URI you want the activity to handle.
The type property specifies a MIME type the activity can handle.
For Broadcast Intents, do not use the data
or type
properties. Use extras to pass data.
See the Extras section below.
Add a category to your Intent by invoking the addCategory() method on it. A category provides additional details about the purpose of the intent. Note that most categories are only useful for intent filters.
Titanium exposes some of the Android Intent categories as the Titanium.Android.CATEGORY_*
constants.
Note that some of these categories are for Notifications. If Titanium has not exposed a
particular constant, you can pass the string value listed in the Android API reference instead.
You can also define your own custom category names. Use a reverse domain scheme to name the
category to avoid potential conflicts, for example, org.foo.category.SUPER
.
Custom categories are only useful to communicate between your applications and application
activities using intents.
Bitwise-OR flags with the Intent's flags property or pass a flag to the addFlags() method. Flags modify the behavior of the intent.
Titanium exposes some of the Android Intent flags as the Titanium.Android.FLAG_*
constants.
If Titanium has not exposed a particular constant, you can pass the constant value listed in
the Android API reference instead.
Extras are key-value pairs that are useful to pass on extra data with the Intent that can be used by another application component.
get*Extra()
methods to retrieve the data. Pass the method the extra key.Titanium exposes the Android-defined extra keys as the Titanium.Android.EXTRA_*
constants.
You can also define your own custom extra keys to use between your applications and application
components.
This example creates an intent and uses it to launch a new activity.
var intent = Ti.Android.createIntent({
action: Ti.Android.ACTION_MAIN,
url: 'activity1.js'
});
intent.addCategory(Ti.Android.CATEGORY_LAUNCHER);
Ti.Android.currentActivity.startActivity(intent);
This example creates an intent to retrieve contact information from the user's contacts.
var intent = Ti.Android.createIntent({
action: Ti.Android.ACTION_GET_CONTENT,
type: "vnd.android.cursor.item/phone"
});
This example creates an intent to pick an image from the photo gallery.
var intent = Ti.Android.createIntent({
action: Ti.Android.ACTION_PICK,
type: "image/*"
});
intent.addCategory(Ti.Android.CATEGORY_DEFAULT);
This example requires that an intent filter be set up in the project's tiapp.xml
file.
After copying the default root activity of your application from the AndroidManifest.xml
file to the Android manifest section of the tiapp.xml
file, add an intent filter.
For detailed instructions, refer to the
Android Intent Filters guide.
You can trigger this intent filter by long pressing on an image in the Android gallery and selecting "share".
tiapp.xml
:
<ti:app>
<android>
<manifest>
<application>
<activity android:name=".YourapplicationnameActivity">
<intent-filter>
<data android:mimeType="image/*"/>
<action android:name="android.intent.action.SEND"/>
<category android:name="android.intent.category.DEFAULT"/>
</intent-filter>
</activity>
</application>
</manifest>
</android>
</ti:app>
app.js
:
var win = Ti.UI.createWindow({
backgroundColor: '#fff',
fullscreen: false,
exitOnClose: true
});
win.addEventListener('open', function(e) {
var intent = Ti.Android.currentActivity.getIntent();
var iname = Ti.Android.EXTRA_STREAM;
if (intent && intent.hasExtra(iname)) {
// Create ImageView from TiBlob
var blob = intent.getBlobExtra(iname);
win.add(Ti.UI.createImageView({
image: blob,
height: 300,
width: 300,
left: 0,
top: 0
}));
} else {
Ti.API.info('No extra named "' + iname + '" found in Intent');
}
});
win.open();
The action associated with this intent.
The action associated with this intent.
Specify one of the ACTION
constants from Titanium.Android, or an application-specific custom action string.
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
.
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
The Java class name of the activity associated with this intent (packageName must also be set).
The Java class name of the activity associated with this intent (packageName must also be set).
The Intent's Data URI.
The Intent's Data URI.
The data URI can be set when the intent is created. It is read-only after the intent is created.
For more information on data URIs, see: Intent.setData in the Android API Reference
Intent flags.
This API can be assigned the following constants:
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.
The fully-qualified Java package name of the activity.
The fully-qualified Java package name of the activity.
The MIME type for this Intent.
The MIME type for this Intent.
The MIME type can be set when the intent is created. It is read-only after the intent is created.
For information on MIME types and intents, see: Intent.setType in the Android API Reference.
The URL to a Titanium JavaScript Activity.
The URL to a Titanium JavaScript Activity.
Adds a category to this Intent.
The category name.
This API can be assigned the following constants:
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
Adds to the existing flags on the Intent
.
The specified flag are combined with the existing flags using a bitwise OR.
Bitwise OR of the flags to add to the existing set.
This API can be assigned the following constants:
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.
A dictionary of properties to apply.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Get a Titanium.Blob property from this Intent
.
The Titanium.Blob extra to get, most commonly Titanium.Android.EXTRA_STREAM.
Get a boolean property from this Intent.
Property to get.
Get a double property from this Intent
.
Property to get.
Get an integer property from this Intent
.
Property to get.
Get a long property from this Intent
.
Property to get.
Get a string property from this Intent
.
Can also be used to get the string representation of a property that's stored
as an Android Parcel
, such as a URI.
Titanium does not support getParcelableExtra
due to the inability to translate
all of its possible return types to JavaScript.
See also: [getParcelableExtra](http://developer.android.com/reference/android/content/Intent.html#getParcelableExtra(java.lang.String) in the Android Developer Reference.
Property to get.
Returns true
if this Intent
has the specified property.
Property name to check for.
Puts an extra property on this Intent
.
Name of the property to add.
Property value to set.
Put a URI property on this Intent
(useful for Titanium.Android.EXTRA_STREAM).
The property name.
The URI, as a string or a string array.
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 of the event.
Callback function to remove. Must be the same function passed to addEventListener
.
Sets the value of the action property.
New value for the property.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the className property.
New value for the property.
Sets the value of the flags property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Sets the value of the packageName property.
New value for the property.