Skip to content
Titanium SDK

Version13.1.1

You are reading 13.1.1. See this page in 13.4.1.

Titanium.Android.Intent

proxyAndroidsince 1.5

Extends Titanium.Proxy

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.

Action

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.

Data

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.

Category

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.

Flags

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

Extras are key-value pairs that are useful to pass on extra data with the Intent that can be used by another application component.

  • Use one of the get*Extra() methods to retrieve the data. Pass the method the extra key.
  • Use the hasExtra() method to check if the intent contains an extra. Pass the method the key of the extra.
  • Use the putExtra() method to add data to the intent. Pass the method the extra key and data.

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.

Further Reading

Examples

Create an Intent for Launching an Activity

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);

Create an Intent to get a Contact URI

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"
});

Pick a Photo from the Photo Gallery

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);

Create an ImageView from an Image Send Intent

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();

Properties 10

action

String

The action associated with this intent.

Specify one of the ACTION constants from Titanium.Android, or an application-specific custom action string.

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

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

Default: true

className

String

The Java class name of the activity associated with this intent (packageName must also be set).

flags

Number

Intent flags.

Accepts 32 constants

packageName

String

The fully-qualified Java package name of the activity.

type

Stringread-only

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.

url

String

The URL to a Titanium JavaScript Activity.

Methods 16

addCategory

Adds a category to this Intent.

Parameters
ParametersTypeDescription
nameString

The category name.

addEventListener

Inherited from Titanium.Proxy

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

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to invoke when the event is fired.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.

addFlags

Adds to the existing flags on the Intent.

The specified flag are combined with the existing flags using a bitwise OR.

Parameters
ParametersTypeDescription
flagsNumber

Bitwise OR of the flags to add to the existing set.

fireEvent

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
ParametersTypeDescription
nameString

Name of the event.

event?Dictionary

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

getBooleanExtra

Get a boolean property from this Intent.

Parameters
ParametersTypeDescription
nameString

Property to get.

defaultBoolean

Default value to return if property does not exist or is of a different type.

Returns Boolean

getData

deprecated

Deprecated since 10.0.0, removed in 10.0.0

Use the <Titanium.Android.Intent.data> property instead.

Get the Data URI from this Intent.

Returns String

getDoubleExtra

Get a double property from this Intent.

Parameters
ParametersTypeDescription
nameString

Property to get.

defaultNumber

Default value to return if property does not exist or is of a different type.

Returns Number

getIntExtra

Get an integer property from this Intent.

Parameters
ParametersTypeDescription
nameString

Property to get.

defaultNumber

Default value to return if property does not exist or is of a different type.

Returns Number

getLongExtra

Get a long property from this Intent.

Parameters
ParametersTypeDescription
nameString

Property to get.

defaultNumber

Default value to return if property does not exist or is of a different type.

Returns Number

getStringExtra

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](https://developer.android.com/reference/android/content/Intent.html#getParcelableExtra(java.lang.String) in the Android Developer Reference.

Parameters
ParametersTypeDescription
nameString

Property to get.

Returns String

hasExtra

Returns true if this Intent has the specified property.

Parameters
ParametersTypeDescription
nameString

Property name to check for.

Returns Boolean

putExtra

Puts an extra property on this Intent.

Parameters
ParametersTypeDescription
nameString

Name of the property to add.

valueany

Property value to set.

putExtraUri

Put a URI property on this Intent (useful for Titanium.Android.EXTRA_STREAM).

Parameters
ParametersTypeDescription
nameString

The property name.

valueString | Array<String>

The URI, as a string or a string array.

removeEventListener

Inherited from Titanium.Proxy

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

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

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

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.