You are reading 13.0.0. See this page in 13.4.1.
Titanium.Android.Activity
Extends Titanium.Proxy
The Titanium binding of an Android Activity.
According to the Android API Reference, an activity is "a single, focused thing that a user can do."
In almost all cases, an activity is associated with a window. Activities are central to the Android Back button navigation -- the Back button closes the current activity and returns to whatever activity was open previously.
In Titanium, the Android Activity is not created until a window or tab group is opened.
After a Window or TabGroup object is created but before it is opened, its activity property
refers to an empty JavaScript object. You can use it to set properties on the activity, such as
the onCreateOptionsMenu property, but you cannot invoke any Activity methods.
After the window or tab group opens, a real Activity object is created and the properties from
the JavaScript object are copied over. The activity property now refers to this real Activity object,
which you can use to call the various Activity methods. For example, to use the
invalidateOptionsMenu method, you need to get the activity after the window or tab group opens.
See also android.app.Activity in the Android API Reference.
Activity Lifecycle
In Android, activities are created, started, resumed, paused, stopped, destroyed and restarted. Titanium generates lifecycle events for activities but does not generate application-level events. To be notified when an activity's lifecycle event is triggered, assign callbacks to the following activity properties:
See also the "Understand the Lifecycle Callbacks" section in Android Developers: Activity Lifecycle.
Don't keep activities option
Android 4.0 and greater devices have an option called Don't keep activities under the Developer Options menu. When this option is enabled, the Android OS will destroy an activity as soon as it is stopped. It is intended to help developers debug their apps. For example, it can simulate the case that Android will kill an activity in the background due to memory pressure. In normal use, it is not recommended to turn this option on because this may lead to unexpected issues on the apps, such as freezes, force closes and reboots.
When the Don't keep activities option is enabled, the lifecycle of the activity is different
from the normal case. Whenever the user leaves an activity, such as backgrounding the app using the
HOME button, this activity is destroyed by Android, which calls onDestroy. In the normal case, onStop
would be called and the activity would not be destroyed. Later, when the user goes back to that activity, this
activity will be recreated, which calls onCreate. In the normal case, since the activity is not destroyed,
onRestart would be called instead. Therefore, some events, such as the open and close events on the Window
or TabGroup, will be fired differently from the normal case, and the root window of the app must set
exitOnClose to true; otherwise, the app will be unable to back out, that is,
hitting the BACK button in the root window will not allow the application to exit.
Deprecated Behavior
Prior to Release 8.0.0, you would set the below "tiapp.xml" property to true to handle the case
where the Android OS would automatically close all child activity windows after the app has been backgrounded
for about 30 minutes, bringing the app back to the root splash screen activity window. The below property
would restart your app's UI in this case. This is no longer needed in 8.0.0 since Titanium now sets the
"AndroidManifest.xml" setting
android:alwaysRetainTaskState
to the root activity instead
<property name="ti.android.root.reappears.restart" type="bool">true</property>
Prior to Release 3.4.0, to monitor lifecycle events, use the activity's events, create, destroy,
pause, resume, start and stop, to be notified when an activity is created, destroyed, paused,
resumed, started and stopped, respectively.
You can only set Activity properties from a TabGroup object after the tab group opens.
Prior to Release 3.2.0, you can create either a "lightweight" or "heavyweight" window, as
described on the Titanium.UI.Window reference page. A heavyweight window creates a
new Activity. A lightweight window runs inside the same activity as the code that
created it. If you try to reference the activity of lightweight window, it returns undefined.
Examples
Callback Example
The following example shows how to start an activity and retrieve a result code and optional data intent when the activity ends.
activity.startActivityForResult(intent, function(e) {
// The request code used to start this Activity
var requestCode = e.requestCode;
// The result code returned from the activity
// (https://developer.android.com/reference/android/app/Activity.html#StartingActivities)
var resultCode = e.resultCode;
// A Titanium.Android.Intent filled with data returned from the Activity
var intent = e.intent;
// The Activity the received the result
var source = e.source;
});
Properties 16
The action bar for this activity.
See also: Action Bar in the Android Developer Reference.
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
The last Intent received by this activity.
Will initially be set to the intent that created/launched the activity. If this is the app's root activity, then this intent will change when a "newintent" event has been fired.
Inherited from Titanium.Proxy
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
Callback function called when the Android activity is created.
onCreateOptionsMenu
Callback<OptionsMenuCallbackObject>Callback function called to initially create an Android options menu for this Activity when the user presses the Menu button.
See the menu examples in Titanium.Android.Menu.
See also: Creating an Options Menu in the Android Developer's Guide.
Callback function called when the Android activity is destroyed.
Callback function called when the Android activity is paused.
onPrepareOptionsMenu
Callback<OptionsMenuCallbackObject>Callback function called to prepare an options menu for display when the user presses the Menu button.
See the menu examples in Titanium.Android.Menu.
See also: Creating an Options Menu in the Android Developer's Guide.
Callback function called when the Android activity is restarted.
Callback function called when the Android activity is resumed.
Callback function called when the Android activity is started.
Callback function called when the Android activity is stopped.
Specifies a specific orientation for this activity.
Toolbar instance that serves as ActionBar
This property is used to set a toolbar as an ActionBar prior to the actual activity creation. After the activity is created that must be done through the setSupportActionBar() method.
Methods 15
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Closes this activity.
See also: finish in the Android API Reference.
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | 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. |
Gets an Android or Application string using the specified Resource ID and optional format arguments.
If the optional format arguments are supplied, these are substituted for the corresponding format specifiers in the string. For example, given the following string resource:
<string name="greeting">"Hello %1$s, this is %2$s."</string>
You could call getString like this:
Ti.Android.currentActivity.getString(Ti.App.Android.R.string.greeting, "Bob", "Doug" );
The resulting string is:
"Hello Bob, this is Doug."
See also:
- getString in the Android Developer Reference
- Formatter in the Android Developer Reference
- String Resources in the Android Developer Guide
| Parameters | Type | Description |
|---|---|---|
| resourceId | Number | Resource ID from the Application or Android. |
| format? | any | Optional format arguments for the String resource. May be repeated. |
invalidateOptionsMenu
since 3.0.0Declares that the option menu has changed and should be recreated.
This method needs to be used in Android 3.0 and above when changing menus at runtime. See changingTheMenu in the Android API Reference for more details.
openOptionsMenu
since 3.0.0Programmatically opens the options menu.
See also: [onMenuOpened](https://developer.android.com/reference/android/app/Activity.html#onMenuOpened(int, android.view.Menu)) in the Android API Reference.
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|
sendBroadcast
since 3.2.0Broadcast the passed in Intent to all BroadcastReceivers.
| Parameters | Type | Description |
|---|---|---|
| intent | Titanium.Android.Intent | Description of the broadcast. |
sendBroadcastWithPermission
since 3.2.0Broadcast the passed in Intent to all BroadcastReceivers with an optional permission.
| Parameters | Type | Description |
|---|---|---|
| intent | Titanium.Android.Intent | Description of the broadcast. |
| receiverPermission? | String | Name of the permission that the receiver should hold in order to receive the broadcast. |
setRequestedOrientation
deprecatedDeprecated since 10.0.0, removed in 10.0.0
Use the <Titanium.Android.requestedOrientation> property instead
Sets the requested Activity orientation.
See also: setRequestedOrientation in the Android API Reference.
| Parameters | Type | Description |
|---|---|---|
| orientation | Number | Orientation mode for the activity. |
Sets the result of this activity using an Intent.
This method should only be used by Ti.Android.rootActivity when launched
by another app via startActivityForResult. After calling
setResult(), you are expected to call the root activity's finish
method afterwards to return the result to the calling app.
See Android's documentation for setResult.
| Parameters | Type | Description |
|---|---|---|
| resultCode | Number | Result code for this activity. |
| intent? | Titanium.Android.Intent | An optional |
setSupportActionBar
since 6.2.0Sets a toolbar instance to be used as an ActionBar.
This method is used if you want to add a Toolbar as an ActionBar after the Activity has been created. If you want to set it up before that supportToolbar must be used.
| Parameters | Type | Description |
|---|---|---|
| toolbar | Titanium.UI.Toolbar | Instance of a toolbar to be used as an ActionBar |
Starts a new activity, using the passed in Intent as the description.
See also: startActivity in the Android Developer Reference.
| Parameters | Type | Description |
|---|---|---|
| intent | Titanium.Android.Intent | Description of the activity to start. |
The same as startActivity, but also accepts a callback function for handling the result of the started Activity.
See also: [startActivityForResult](https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int)) in the Android Developer Reference.
| Parameters | Type | Description |
|---|---|---|
| intent | Titanium.Android.Intent | Description of the activity to start. |
| callback | Callback<ActivityResult> | Callback function to be executed when the activity sets result. See examples. 3 fields
|
Events 4
newintent
since 3.0.0Fired when the activity is already running and an intent different than the one that launched it was received.
This event will only be fired by Ti.Android.rootActivity, which is the splash screen activity. This event will never be fired by any of the child activities. The root activity' intent property will be updated when to the new intent when fired.
See also: onNewIntent in the Android Developer Reference.
| Event properties | Type | Description |
|---|---|---|
| intent | Titanium.Android.Intent | The |
onIntent
since 6.0.0Fired when the activity is launched.
| Event properties | Type | Description |
|---|---|---|
| intent | Titanium.Android.Intent | The |
userinteraction
since 7.5.0Called whenever a key, touch, or trackball event is dispatched to the activity.
Implement this method if you wish to know that the user has interacted with the device in some
way while your activity is running. This event and userleavehint are intended to help activities
manage status bar notifications intelligently; specifically, for helping activities determine the
proper time to cancel a notfication.
All calls to your activity's "userleavehint" event will be accompanied by calls to "userinteraction". This ensures that your activity will be told of relevant user activity such as pulling down the notification pane and touching an item there.
Note that this callback will be invoked for the touch down action that begins a touch gesture, but may not be invoked for the touch-moved and touch-up actions that follow.
See also: onUserInteraction in the Android Developer Reference.
userleavehint
since 3.2.0Fired when the activity is about to go into the background as a result of user choice.
See also: onUserLeaveHint in the Android Developer Reference.