Unit |
addContentView(view: View!, params: ViewGroup.LayoutParams!)
Add an additional content view to the activity. Added after any existing ones in the activity -- existing views are NOT removed.
|
Unit |
attachBaseContext(newBase: Context!)
|
Unit |
clearOverrideActivityTransition(overrideType: Int)
Clears the animations which are set from #overrideActivityTransition.
|
Unit |
closeContextMenu()
Programmatically closes the most recently opened context menu, if showing.
|
Unit |
closeOptionsMenu()
Progammatically closes the options menu. If the options menu is already closed, this method does nothing.
|
PendingIntent! |
createPendingResult(requestCode: Int, data: Intent, flags: Int)
Create a new PendingIntent object which you can hand to others for them to use to send result data back to your #onActivityResult callback. The created object will be either one-shot (becoming invalid after a result is sent back) or multiple (allowing any number of results to be sent through it).
|
Unit |
dismissDialog(id: Int)
Dismiss a dialog that was previously shown via showDialog(int).
|
Unit |
dismissKeyboardShortcutsHelper()
Dismiss the Keyboard Shortcuts screen.
|
Boolean |
dispatchGenericMotionEvent(ev: MotionEvent!)
Called to process generic motion events. You can override this to intercept all generic motion events before they are dispatched to the window. Be sure to call this implementation for generic motion events that should be handled normally.
|
Boolean |
dispatchKeyEvent(event: KeyEvent!)
Called to process key events. You can override this to intercept all key events before they are dispatched to the window. Be sure to call this implementation for key events that should be handled normally.
|
Boolean |
dispatchKeyShortcutEvent(event: KeyEvent!)
Called to process a key shortcut event. You can override this to intercept all key shortcut events before they are dispatched to the window. Be sure to call this implementation for key shortcut events that should be handled normally.
|
Boolean |
dispatchPopulateAccessibilityEvent(event: AccessibilityEvent!)
|
Boolean |
dispatchTouchEvent(ev: MotionEvent!)
Called to process touch screen events. You can override this to intercept all touch screen events before they are dispatched to the window. Be sure to call this implementation for touch screen events that should be handled normally.
|
Boolean |
dispatchTrackballEvent(ev: MotionEvent!)
Called to process trackball events. You can override this to intercept all trackball events before they are dispatched to the window. Be sure to call this implementation for trackball events that should be handled normally.
|
Unit |
dump(prefix: String, fd: FileDescriptor?, writer: PrintWriter, args: Array<String!>?)
Print the Activity's state into the given stream. This gets invoked if you run adb shell dumpsys activity <activity_component_name>.
This method won't be called if the app targets android.os.Build.VERSION_CODES#TIRAMISU or later if the dump request starts with one of the following arguments:
- --autofill
- --contentcapture
- --translation
- --list-dumpables
- --dump-dumpable
|
Unit |
enterPictureInPictureMode()
Puts the activity in picture-in-picture mode if possible in the current system state. Any prior calls to setPictureInPictureParams(android.app.PictureInPictureParams) will still apply when entering picture-in-picture through this call.
|
Boolean |
enterPictureInPictureMode(params: PictureInPictureParams)
Puts the activity in picture-in-picture mode if possible in the current system state. The set parameters in {@param params} will be combined with the parameters from prior calls to setPictureInPictureParams(android.app.PictureInPictureParams). The system may disallow entering picture-in-picture in various cases, including when the activity is not visible, if the screen is locked or if the user has an activity pinned.
By default, system calculates the dimension of picture-in-picture window based on the given {@param params}. See Picture-in-picture Support on how to override this behavior.
|
T |
findViewById(id: Int)
Finds a view that was identified by the android:id XML attribute that was processed in #onCreate.
Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.
|
Unit |
finish()
Call this when your activity is done and should be closed. The ActivityResult is propagated back to whoever launched you via onActivityResult().
|
Unit |
finishActivity(requestCode: Int)
Force finish another activity that you had previously started with #startActivityForResult.
|
Unit |
finishActivityFromChild(child: Activity, requestCode: Int)
This is called when a child activity of this one calls its finishActivity().
|
Unit |
finishAffinity()
Finish this activity as well as all activities immediately below it in the current task that have the same affinity. This is typically used when an application can be launched on to another task (such as from an ACTION_VIEW of a content type it understands) and the user has used the up navigation to switch out of the current task and in to its own task. In this case, if the user has navigated down into any other activities of the second application, all of those should be removed from the original task as part of the task switch.
Note that this finish does not allow you to deliver results to the previous activity, and an exception will be thrown if you are trying to do so.
|
Unit |
finishAfterTransition()
Reverses the Activity Scene entry Transition and triggers the calling Activity to reverse its exit Transition. When the exit Transition completes, finish() is called. If no entry Transition was used, finish() is called immediately and the Activity exit Transition is run.
|
Unit |
finishAndRemoveTask()
Call this when your activity is done and should be closed and the task should be completely removed as a part of finishing the root activity of the task.
|
Unit |
finishFromChild(child: Activity!)
This is called when a child activity of this one calls its finish method. The default implementation simply calls finish() on this activity (the parent), finishing the entire group.
|
ActionBar? |
getActionBar()
Retrieve a reference to this activity's ActionBar.
|
Application! |
getApplication()
Return the application that owns this activity.
|
ComponentCaller? |
getCaller()
Returns the ComponentCaller instance of the app that started this activity.
To keep the ComponentCaller instance for future use, call setIntent(android.content.Intent,android.app.ComponentCaller), and use this method to retrieve it.
Note that in #onNewIntent, this method will return the original ComponentCaller. You can use setIntent(android.content.Intent,android.app.ComponentCaller) to update it to the new ComponentCaller.
|
ComponentName? |
getCallingActivity()
Return the name of the activity that invoked this activity. This is who the data in #setResult will be sent to. You can use this information to validate that the recipient is allowed to receive the data.
Note: if the calling activity is not expecting a result (that is it did not use the #startActivityForResult form that includes a request code), then the calling package will be null.
|
String? |
getCallingPackage()
Return the name of the package that invoked this activity. This is who the data in #setResult will be sent to. You can use this information to validate that the recipient is allowed to receive the data.
Note: if the calling activity is not expecting a result (that is it did not use the #startActivityForResult form that includes a request code), then the calling package will be null.
Note: prior to android.os.Build.VERSION_CODES#JELLY_BEAN_MR2, the result from this method was unstable. If the process hosting the calling package was no longer running, it would return null instead of the proper package name. You can use getCallingActivity() and retrieve the package name from that instead.
|
Int |
getChangingConfigurations()
If this activity is being destroyed because it can not handle a configuration parameter being changed (and thus its onConfigurationChanged(android.content.res.Configuration) method is not being called), then you can use this method to discover the set of changes that have occurred while in the process of being destroyed. Note that there is no guarantee that these will be accurate (other changes could have happened at any time), so you should only use this as an optimization hint.
|
ComponentName! |
getComponentName()
Returns the complete component name of this activity.
|
Scene! |
getContentScene()
Retrieve the Scene representing this window's current content. Requires Window#FEATURE_CONTENT_TRANSITIONS.
This method will return null if the current content is not represented by a Scene.
|
TransitionManager! |
getContentTransitionManager()
Retrieve the TransitionManager responsible for default transitions in this window. Requires Window#FEATURE_CONTENT_TRANSITIONS.
This method will return non-null after content has been initialized (e.g. by using #setContentView) if Window#FEATURE_CONTENT_TRANSITIONS has been granted.
|
ComponentCaller |
getCurrentCaller()
Returns the ComponentCaller instance of the app that re-launched this activity with a new intent via #onNewIntent or #onActivityResult.
Note that this method only works within the #onNewIntent and #onActivityResult methods. If you call this method outside #onNewIntent and #onActivityResult, it will throw an IllegalStateException.
You can also retrieve the caller if you override onNewIntent(android.content.Intent,android.app.ComponentCaller) or onActivityResult(int,int,android.content.Intent,android.app.ComponentCaller).
To keep the ComponentCaller instance for future use, call setIntent(android.content.Intent,android.app.ComponentCaller), and use getCaller to retrieve it.
|
View? |
getCurrentFocus()
Calls android.view.Window#getCurrentFocus on the Window of this Activity to return the currently focused view.
|
FragmentManager! |
getFragmentManager()
Return the FragmentManager for interacting with fragments associated with this activity.
|
ComponentCaller |
getInitialCaller()
Returns the ComponentCaller instance of the app that initially launched this activity.
Note that calls to #onNewIntent and #setIntent have no effect on the returned value of this method.
|
Intent! |
getIntent()
Returns the intent that started this activity.
To keep the Intent instance for future use, call setIntent(android.content.Intent), and use this method to retrieve it.
Note that in #onNewIntent, this method will return the original Intent. You can use setIntent(android.content.Intent) to update it to the new Intent.
|
Any? |
getLastNonConfigurationInstance()
Retrieve the non-configuration instance data that was previously returned by onRetainNonConfigurationInstance(). This will be available from the initial #onCreate and onStart calls to the new instance, allowing you to extract any useful dynamic state from the previous instance.
Note that the data you retrieve here should only be used as an optimization for handling configuration changes. You should always be able to handle getting a null pointer back, and an activity must still be able to restore itself to its previous state (through the normal onSaveInstanceState(android.os.Bundle) mechanism) even if this function returns null.
Note: For most cases you should use the Fragment API Fragment#setRetainInstance(boolean) instead; this is also available on older platforms through the Android support libraries.
|
String? |
getLaunchedFromPackage()
Returns the package name of the app that initially launched this activity.
In order to receive the launching app's package name, at least one of the following has to be met:
- The app must call
ActivityOptions#setShareIdentityEnabled(boolean) with a value of true and launch this activity with the resulting ActivityOptions.
- The launched activity has the same uid as the launching app.
- The launched activity is running in a package that is signed with the same key used to sign the platform (typically only system packages such as Settings will meet this requirement).
. These are the same requirements for getLaunchedFromUid(); if any of these are met, then these methods can be used to obtain the uid and package name of the launching app. If none are met, then null is returned.
Note, even if the above conditions are not met, the launching app's identity may still be available from getCallingPackage() if this activity was started with Activity#startActivityForResult to allow validation of the result's recipient.
|
Int |
getLaunchedFromUid()
Returns the uid of the app that initially launched this activity.
In order to receive the launching app's uid, at least one of the following has to be met:
- The app must call
ActivityOptions#setShareIdentityEnabled(boolean) with a value of true and launch this activity with the resulting ActivityOptions.
- The launched activity has the same uid as the launching app.
- The launched activity is running in a package that is signed with the same key used to sign the platform (typically only system packages such as Settings will meet this requirement).
. These are the same requirements for getLaunchedFromPackage(); if any of these are met, then these methods can be used to obtain the uid and package name of the launching app. If none are met, then Process#INVALID_UID is returned.
Note, even if the above conditions are not met, the launching app's identity may still be available from getCallingPackage() if this activity was started with Activity#startActivityForResult to allow validation of the result's recipient.
|
LayoutInflater |
getLayoutInflater()
Convenience for calling android.view.Window#getLayoutInflater.
|
LoaderManager! |
getLoaderManager()
Return the LoaderManager for this activity, creating it if needed.
|
String |
getLocalClassName()
Returns class name for this activity with the package prefix removed. This is the default name used to read and write settings.
|
Int |
getMaxNumPictureInPictureActions()
Return the number of actions that will be displayed in the picture-in-picture UI when the user interacts with the activity currently in picture-in-picture mode. This number may change if the global configuration changes (ie. if the device is plugged into an external display), but will always be at least three.
|
MediaController! |
getMediaController()
Gets the controller which should be receiving media key and volume events while this activity is in the foreground.
|
MenuInflater |
getMenuInflater()
Returns a MenuInflater with this context.
|
OnBackInvokedDispatcher |
getOnBackInvokedDispatcher()
Returns the OnBackInvokedDispatcher instance associated with the window that this activity is attached to.
|
Activity! |
getParent()
Returns the parent Activity if this is a child Activity of an ActivityGroup.
|
Intent? |
getParentActivityIntent()
Obtain an Intent that will launch an explicit target activity specified by this activity's logical parent. The logical parent is named in the application's manifest by the parentActivityName attribute. Activity subclasses may override this method to modify the Intent returned by super.getParentActivityIntent() or to implement a different mechanism of retrieving the parent intent entirely.
|
SharedPreferences! |
getPreferences(mode: Int)
Retrieve a SharedPreferences object for accessing preferences that are private to this activity. This simply calls the underlying getSharedPreferences(java.lang.String,int) method by passing in this activity's class name as the preferences name.
|
Uri? |
getReferrer()
Return information about who launched this activity. If the launching Intent contains an Intent.EXTRA_REFERRER, that will be returned as-is; otherwise, if known, an android-app: referrer URI containing the package name that started the Intent will be returned. This may return null if no referrer can be identified -- it is neither explicitly specified, nor is it known which application package was involved.
If called while inside the handling of #onNewIntent, this function will return the referrer that submitted that new intent to the activity only after setIntent(android.content.Intent) is called with the provided intent.
Note that this is not a security feature -- you can not trust the referrer information, applications can spoof it.
|
Int |
getRequestedOrientation()
Return the current requested orientation of the activity. This will either be the orientation requested in its component's manifest, or the last requested orientation given to setRequestedOrientation(int).
|
SearchEvent! |
getSearchEvent()
During the onSearchRequested() callbacks, this function will return the SearchEvent that triggered the callback, if it exists.
|
SplashScreen |
getSplashScreen()
Get the interface that activity use to talk to the splash screen.
|
Any! |
getSystemService(name: String)
Return the handle to a system-level service by name. The class of the returned object varies by the requested name. Currently available names are:
-
WINDOW_SERVICE ("window")
- The top-level window manager in which you can place custom windows. The returned object is a
android.view.WindowManager. Must only be obtained from a visual context such as Activity or a Context created with createWindowContext(int,android.os.Bundle), which are adjusted to the configuration and visual bounds of an area on screen.
-
LAYOUT_INFLATER_SERVICE ("layout_inflater")
- A
android.view.LayoutInflater for inflating layout resources in this context. Must only be obtained from a visual context such as Activity or a Context created with createWindowContext(int,android.os.Bundle), which are adjusted to the configuration and visual bounds of an area on screen.
-
ACTIVITY_SERVICE ("activity")
- A
android.app.ActivityManager for interacting with the global activity state of the system.
-
WALLPAPER_SERVICE ("wallpaper")
- A
android.service.wallpaper.WallpaperService for accessing wallpapers in this context. Must only be obtained from a visual context such as Activity or a Context created with createWindowContext(int,android.os.Bundle), which are adjusted to the configuration and visual bounds of an area on screen.
-
POWER_SERVICE ("power")
- A
android.os.PowerManager for controlling power management.
-
ALARM_SERVICE ("alarm")
- A
android.app.AlarmManager for receiving intents at the time of your choosing.
-
NOTIFICATION_SERVICE ("notification")
- A
android.app.NotificationManager for informing the user of background events.
-
KEYGUARD_SERVICE ("keyguard")
- A
android.app.KeyguardManager for controlling keyguard.
-
LOCATION_SERVICE ("location")
- A
android.location.LocationManager for controlling location (e.g., GPS) updates.
-
SEARCH_SERVICE ("search")
- A
android.app.SearchManager for handling search.
-
VIBRATOR_MANAGER_SERVICE ("vibrator_manager")
- A
android.os.VibratorManager for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators.
-
VIBRATOR_SERVICE ("vibrator")
- A
android.os.Vibrator for interacting with the vibrator hardware.
-
CONNECTIVITY_SERVICE ("connectivity")
- A
ConnectivityManager for handling management of network connections.
-
IPSEC_SERVICE ("ipsec")
- A
IpSecManager for managing IPSec on sockets and networks.
-
WIFI_SERVICE ("wifi")
- A
WifiManager for management of Wi-Fi connectivity. On releases before Android 7, it should only be obtained from an application context, and not from any other derived context to avoid memory leaks within the calling process.
-
WIFI_AWARE_SERVICE ("wifiaware")
- A
WifiAwareManager for management of Wi-Fi Aware discovery and connectivity.
-
WIFI_P2P_SERVICE ("wifip2p")
- A
WifiP2pManager for management of Wi-Fi Direct connectivity.
-
INPUT_METHOD_SERVICE ("input_method")
- An
InputMethodManager for management of input methods.
-
UI_MODE_SERVICE ("uimode")
- An
android.app.UiModeManager for controlling UI modes.
-
DOWNLOAD_SERVICE ("download")
- A
android.app.DownloadManager for requesting HTTP downloads
-
BATTERY_SERVICE ("batterymanager")
- A
android.os.BatteryManager for managing battery state
-
JOB_SCHEDULER_SERVICE ("taskmanager")
- A
android.app.job.JobScheduler for managing scheduled tasks
-
NETWORK_STATS_SERVICE ("netstats")
- A
NetworkStatsManager for querying network usage statistics.
-
HARDWARE_PROPERTIES_SERVICE ("hardware_properties")
- A
android.os.HardwarePropertiesManager for accessing hardware properties.
-
DOMAIN_VERIFICATION_SERVICE ("domain_verification")
- A
android.content.pm.verify.domain.DomainVerificationManager for accessing web domain approval state.
-
DISPLAY_HASH_SERVICE ("display_hash")
- A
android.view.displayhash.DisplayHashManager for management of display hashes.
Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)
Note: Instant apps, for which PackageManager#isInstantApp() returns true, don't have access to the following system services: DEVICE_POLICY_SERVICE, FINGERPRINT_SERVICE, KEYGUARD_SERVICE, SHORTCUT_SERVICE, USB_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WIFI_AWARE_SERVICE. For these services this method will return null. Generally, if you are running as an instant app you should always check whether the result of this method is null.
Note: When implementing this method, keep in mind that new services can be added on newer Android releases, so if you're looking for just the explicit names mentioned above, make sure to return null when you don't recognize the name — if you throw a RuntimeException exception instead, your app might break on new Android releases.
|
Int |
getTaskId()
Return the identifier of the task this activity is in. This identifier will remain the same for the lifetime of the activity.
|
CharSequence! |
getTitle()
|
Int |
getTitleColor()
|
VoiceInteractor! |
getVoiceInteractor()
Retrieve the active VoiceInteractor that the user is going through to interact with this activity.
|
Int |
getVolumeControlStream()
Gets the suggested audio stream whose volume should be changed by the hardware volume controls.
|
Window! |
getWindow()
Retrieve the current android.view.Window for the activity. This can be used to directly access parts of the Window API that are not available through Activity/Screen.
|
WindowManager! |
getWindowManager()
Retrieve the window manager for showing custom windows.
|
Boolean |
hasWindowFocus()
Returns true if this activity's main window currently has window focus. Note that this is not the same as the view itself having focus.
|
Unit |
invalidateOptionsMenu()
Declare that the options menu has changed, so should be recreated. The onCreateOptionsMenu(android.view.Menu) method will be called the next time it needs to be displayed.
|
Boolean |
isActivityTransitionRunning()
Returns whether there are any activity transitions currently running on this activity. A return value of true can mean that either an enter or exit transition is running, including whether the background of the activity is animating as a part of that transition.
|
Boolean |
isChangingConfigurations()
Check to see whether this activity is in the process of being destroyed in order to be recreated with a new configuration. This is often used in onStop to determine whether the state needs to be cleaned up or will be passed on to the next instance of the activity via onRetainNonConfigurationInstance().
|
Boolean |
isChild()
Whether this is a child Activity of an ActivityGroup.
|
Boolean |
isDestroyed()
Returns true if the final onDestroy() call has been made on the Activity, so this instance is now dead.
|
Boolean |
isFinishing()
Check to see whether this activity is in the process of finishing, either because you called finish on it or someone else has requested that it finished. This is often used in onPause to determine whether the activity is simply pausing or completely finishing.
|
Boolean |
isImmersive()
Bit indicating that this activity is "immersive" and should not be interrupted by notifications if possible. This value is initially set by the manifest property android:immersive but may be changed at runtime by setImmersive.
|
Boolean |
isInMultiWindowMode()
Returns true if the activity is currently in multi-window mode.
|
Boolean |
isInPictureInPictureMode()
Returns true if the activity is currently in picture-in-picture mode.
|
Boolean |
isLaunchedFromBubble()
Indicates whether this activity is launched from a bubble. A bubble is a floating shortcut on the screen that expands to show an activity. If your activity can be used normally or as a bubble, you might use this method to check if the activity is bubbled to modify any behaviour that might be different between the normal activity and the bubbled activity. For example, if you normally cancel the notification associated with the activity when you open the activity, you might not want to do that when you're bubbled as that would remove the bubble.
|
Boolean |
isLocalVoiceInteractionSupported()
Queries whether the currently enabled voice interaction service supports returning a voice interactor for use by the activity. This is valid only for the duration of the activity.
|
Boolean |
isTaskRoot()
Return whether this activity is the root of a task. The root is the first activity in a task.
|
Boolean |
isVoiceInteraction()
Check whether this activity is running as part of a voice interaction with the user. If true, it should perform its interaction with the user through the VoiceInteractor returned by getVoiceInteractor.
|
Boolean |
isVoiceInteractionRoot()
Like isVoiceInteraction, but only returns true if this is also the root of a voice interaction. That is, returns true if this activity was directly started by the voice interaction service as the initiation of a voice interaction. Otherwise, for example if it was started by another activity while under voice interaction, returns false. If the activity launchMode is singleTask, it forces the activity to launch in a new task, separate from the one that started it. Therefore, there is no longer a relationship between them, and isVoiceInteractionRoot() return false in this case.
|
Cursor! |
managedQuery(uri: Uri!, projection: Array<String!>!, selection: String!, selectionArgs: Array<String!>!, sortOrder: String!)
Wrapper around ContentResolver#query(android.net.Uri , String[], String, String[], String) that gives the resulting Cursor to call startManagingCursor so that the activity will manage its lifecycle for you. If you are targeting android.os.Build.VERSION_CODES#HONEYCOMB or later, consider instead using LoaderManager instead, available via getLoaderManager().
Warning: Do not call android.database.Cursor#close() on a cursor obtained using this method, because the activity will do that for you at the appropriate time. However, if you call stopManagingCursor on a cursor from a managed query, the system will not automatically close the cursor and, in that case, you must call android.database.Cursor#close().
|
Boolean |
moveTaskToBack(nonRoot: Boolean)
Move the task containing this activity to the back of the activity stack. The activity's order within the task is unchanged.
|
Boolean |
navigateUpTo(upIntent: Intent!)
Navigate from this activity to the activity specified by upIntent, finishing this activity in the process. If the activity indicated by upIntent already exists in the task's history, this activity and all others before the indicated activity in the history stack will be finished.
If the indicated activity does not appear in the history stack, this will finish each activity in this task until the root activity of the task is reached, resulting in an "in-app home" behavior. This can be useful in apps with a complex navigation hierarchy when an activity may be reached by a path not passing through a canonical parent activity.
This method should be used when performing up navigation from within the same task as the destination. If up navigation should cross tasks in some cases, see shouldUpRecreateTask(android.content.Intent).
|
Boolean |
navigateUpToFromChild(child: Activity!, upIntent: Intent!)
This is called when a child activity of this one calls its navigateUpTo method. The default implementation simply calls navigateUpTo(upIntent) on this activity (the parent).
|
Unit |
onActionModeFinished(mode: ActionMode!)
Notifies the activity that an action mode has finished. Activity subclasses overriding this method should call the superclass implementation.
If you override this method you must call through to the superclass implementation.
|
Unit |
onActionModeStarted(mode: ActionMode!)
Notifies the Activity that an action mode has been started. Activity subclasses overriding this method should call the superclass implementation.
If you override this method you must call through to the superclass implementation.
|
Unit |
onActivityReenter(resultCode: Int, data: Intent!)
Called when an activity you launched with an activity transition exposes this Activity through a returning activity transition, giving you the resultCode and any additional data from it. This method will only be called if the activity set a result code other than RESULT_CANCELED and it supports activity transitions with Window#FEATURE_ACTIVITY_TRANSITIONS.
The purpose of this function is to let the called Activity send a hint about its state so that this underlying Activity can prepare to be exposed. A call to this method does not guarantee that the called Activity has or will be exiting soon. It only indicates that it will expose this Activity's Window and it has some data to pass to prepare it.
|
Unit |
onActivityResult(requestCode: Int, resultCode: Int, data: Intent!)
Called when an activity you launched exits, giving you the requestCode you started it with, the resultCode it returned, and any additional data from it. The resultCode will be RESULT_CANCELED if the activity explicitly returned that, didn't return any result, or crashed during its operation.
An activity can never receive a result in the resumed state. You can count on onResume being called after this method, though not necessarily immediately after. If the activity was resumed, it will be paused and the result will be delivered, followed by onResume. If the activity wasn't in the resumed state, then the result will be delivered, with onResume called sometime later when the activity becomes active again.
This method is never invoked if your activity sets noHistory to true.
|
Unit |
onActivityResult(requestCode: Int, resultCode: Int, data: Intent?, caller: ComponentCaller)
Same as onActivityResult(int,int,android.content.Intent), but with an extra parameter for the ComponentCaller instance associated with the app that sent the result.
If you want to retrieve the caller without overriding this method, call getCurrentCaller inside your existing onActivityResult(int,int,android.content.Intent).
Note that you should only override one #onActivityResult method.
|
Unit |
onApplyThemeResource(theme: Resources.Theme!, resid: Int, first: Boolean)
|
Unit |
onAttachFragment(fragment: Fragment!)
Called when a Fragment is being attached to this activity, immediately after the call to its android.app.Fragment#onAttach method and before Fragment.onCreate().
|
Unit |
onAttachedToWindow()
Called when the main window associated with the activity has been attached to the window manager. See View.onAttachedToWindow() for more information.
|
Unit |
onBackPressed()
Called when the activity has detected the user's press of the back key. The default implementation depends on the platform version:
|
Unit |
onChildTitleChanged(childActivity: Activity!, title: CharSequence!)
|
Unit |
onConfigurationChanged(newConfig: Configuration)
Called by the system when the device configuration changes while your activity is running. Note that this will only be called if you have selected configurations you would like to handle with the android.R.attr#configChanges attribute in your manifest. If any configuration change occurs that is not selected to be reported by that attribute, then instead of reporting it the system will stop and restart the activity (to have it launched with the new configuration). The only exception is if a size-based configuration is not large enough to be considered significant, in which case the system will not recreate the activity and will instead call this method. For details on this see the documentation on size-based config change.
At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration.
|
Unit |
onContentChanged()
|
Boolean |
onContextItemSelected(item: MenuItem)
This hook is called whenever an item in a context menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities.
Use MenuItem#getMenuInfo() to get extra information set by the View that added this menu item.
Derived classes should call through to the base class for it to perform the default menu handling.
|
Unit |
onContextMenuClosed(menu: Menu)
This hook is called whenever the context menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
|
Unit |
onCreate(savedInstanceState: Bundle?, persistentState: PersistableBundle?)
Same as onCreate(android.os.Bundle) but called for those activities created with the attribute android.R.attr#persistableMode set to persistAcrossReboots.
|
Unit |
onCreateContextMenu(menu: ContextMenu!, v: View!, menuInfo: ContextMenu.ContextMenuInfo!)
Called when a context menu for the view is about to be shown. Unlike onCreateOptionsMenu(android.view.Menu), this will be called every time the context menu is about to be shown and should be populated for the view (or item inside the view for AdapterView subclasses, this can be found in the menuInfo)).
Use onContextItemSelected(android.view.MenuItem) to know when an item has been selected.
It is not safe to hold onto the context menu after this method returns.
|
CharSequence? |
onCreateDescription()
Generate a new description for this activity. This method is called before stopping the activity and can, if desired, return some textual description of its current state to be displayed to the user.
The default implementation returns null, which will cause you to inherit the description from the previous activity. If all activities return null, generally the label of the top activity will be used as the description.
|
Dialog! |
onCreateDialog(id: Int)
|
Dialog? |
onCreateDialog(id: Int, args: Bundle!)
Callback for creating dialogs that are managed (saved and restored) for you by the activity. The default implementation calls through to onCreateDialog(int) for compatibility. If you are targeting android.os.Build.VERSION_CODES#HONEYCOMB or later, consider instead using a DialogFragment instead.
If you use showDialog(int), the activity will call through to this method the first time, and hang onto it thereafter. Any dialog that is created by this method will automatically be saved and restored for you, including whether it is showing.
If you would like the activity to manage saving and restoring dialogs for you, you should override this method and handle any ids that are passed to #showDialog.
If you would like an opportunity to prepare your dialog before it is shown, override onPrepareDialog(int,android.app.Dialog,android.os.Bundle).
|
Unit |
onCreateNavigateUpTaskStack(builder: TaskStackBuilder!)
Define the synthetic task stack that will be generated during Up navigation from a different task.
The default implementation of this method adds the parent chain of this activity as specified in the manifest to the supplied TaskStackBuilder. Applications may choose to override this method to construct the desired task stack in a different way.
This method will be invoked by the default implementation of onNavigateUp() if shouldUpRecreateTask(android.content.Intent) returns true when supplied with the intent returned by getParentActivityIntent().
Applications that wish to supply extra Intent parameters to the parent stack defined by the manifest should override onPrepareNavigateUpTaskStack(android.app.TaskStackBuilder).
|
Boolean |
onCreateOptionsMenu(menu: Menu!)
Initialize the contents of the Activity's standard options menu. You should place your menu items in to menu.
This is only called once, the first time the options menu is displayed. To update the menu every time it is displayed, see onPrepareOptionsMenu.
The default implementation populates the menu with standard system menu items. These are placed in the Menu#CATEGORY_SYSTEM group so that they will be correctly ordered with application-defined menu items. Deriving classes should always call through to the base implementation.
You can safely hold on to menu (and any items created from it), making modifications to it as desired, until the next time onCreateOptionsMenu() is called.
When you add items to the menu, you can implement the Activity's onOptionsItemSelected method to handle them there.
|
Boolean |
onCreatePanelMenu(featureId: Int, menu: Menu)
Default implementation of android.view.Window.Callback#onCreatePanelMenu for activities. This calls through to the new onCreateOptionsMenu method for the android.view.Window#FEATURE_OPTIONS_PANEL panel, so that subclasses of Activity don't need to deal with feature codes.
|
View? |
onCreatePanelView(featureId: Int)
Default implementation of android.view.Window.Callback#onCreatePanelView for activities. This simply returns null so that all panel sub-windows will have the default menu behavior.
|
Boolean |
onCreateThumbnail(outBitmap: Bitmap!, canvas: Canvas!)
|
View? |
onCreateView(name: String, context: Context, attrs: AttributeSet)
Standard implementation of android.view.LayoutInflater.Factory#onCreateView used when inflating with the LayoutInflater returned by #getSystemService. This implementation does nothing and is for pre-android.os.Build.VERSION_CODES#HONEYCOMB apps. Newer apps should use onCreateView(android.view.View,java.lang.String,android.content.Context,android.util.AttributeSet).
|
View? |
onCreateView(parent: View?, name: String, context: Context, attrs: AttributeSet)
Standard implementation of android.view.LayoutInflater.Factory2#onCreateView(View, String, Context, AttributeSet) used when inflating with the LayoutInflater returned by #getSystemService. This implementation handles tags to embed fragments inside of the activity.
|
Unit |
onDetachedFromWindow()
Called when the main window associated with the activity has been detached from the window manager. See View.onDetachedFromWindow() for more information.
|
Unit |
onEnterAnimationComplete()
Activities cannot draw during the period that their windows are animating in. In order to know when it is safe to begin drawing they can override this method which will be called when the entering animation has completed.
|
Boolean |
onGenericMotionEvent(event: MotionEvent!)
Called when a generic motion event was not handled by any of the views inside of the activity.
Generic motion events describe joystick movements, hover events from mouse or stylus devices, trackpad touches, scroll wheel movements and other motion events not handled by onTouchEvent(android.view.MotionEvent) or onTrackballEvent(android.view.MotionEvent). The source of the motion event specifies the class of input that was received. Implementations of this method must examine the bits in the source before processing the event.
Generic motion events with source class android.view.InputDevice#SOURCE_CLASS_POINTER are delivered to the view under the pointer. All other generic motion events are delivered to the focused view.
See View#onGenericMotionEvent(MotionEvent) for an example of how to handle this event.
|
Unit |
onGetDirectActions(cancellationSignal: CancellationSignal, callback: Consumer<MutableList<DirectAction!>!>)
Returns the list of direct actions supported by the app.
You should return the list of actions that could be executed in the current context, which is in the current state of the app. If the actions that could be executed by the app changes you should report that via calling VoiceInteractor#notifyDirectActionsChanged().
To get the voice interactor you need to call getVoiceInteractor() which would return non null only if there is an ongoing voice interaction session. You can also detect when the voice interactor is no longer valid because the voice interaction session that is backing is finished by calling VoiceInteractor#registerOnDestroyedCallback(Executor, Runnable).
This method will be called only after onStart() and before onStop().
You should pass to the callback the currently supported direct actions which cannot be null or contain null elements.
You should return the action list as soon as possible to ensure the consumer, for example the assistant, is as responsive as possible which would improve user experience of your app.
|
Boolean |
onKeyDown(keyCode: Int, event: KeyEvent!)
Called when a key was pressed down and not handled by any of the views inside of the activity. So, for example, key presses while the cursor is inside a TextView will not trigger the event (unless it is a navigation to another object) because TextView handles its own key presses.
If the focused view didn't want this event, this method is called.
The default implementation takes care of KeyEvent#KEYCODE_BACK by calling onBackPressed(), though the behavior varies based on the application compatibility mode: for android.os.Build.VERSION_CODES#ECLAIR or later applications, it will set up the dispatch to call onKeyUp where the action will be performed; for earlier applications, it will perform the action immediately in on-down, as those versions of the platform behaved. This implementation will also take care of KeyEvent#KEYCODE_ESCAPE by finishing the activity if it would be closed by touching outside of it.
Other additional default key handling may be performed if configured with setDefaultKeyMode.
|
Boolean |
onKeyLongPress(keyCode: Int, event: KeyEvent!)
Default implementation of KeyEvent.Callback.onKeyLongPress(): always returns false (doesn't handle the event). To receive this callback, you must return true from onKeyDown for the current event stream.
|
Boolean |
onKeyMultiple(keyCode: Int, repeatCount: Int, event: KeyEvent!)
Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).
|
Boolean |
onKeyShortcut(keyCode: Int, event: KeyEvent!)
Called when a key shortcut event is not handled by any of the views in the Activity. Override this method to implement global key shortcuts for the Activity. Key shortcuts can also be implemented by setting the shortcut property of menu items.
|
Boolean |
onKeyUp(keyCode: Int, event: KeyEvent!)
Called when a key was released and not handled by any of the views inside of the activity. So, for example, key presses while the cursor is inside a TextView will not trigger the event (unless it is a navigation to another object) because TextView handles its own key presses.
The default implementation handles KEYCODE_BACK to stop the activity and go back.
|
Unit |
onLocalVoiceInteractionStarted()
Callback to indicate that startLocalVoiceInteraction(android.os.Bundle) has resulted in a voice interaction session being started. You can now retrieve a voice interactor using getVoiceInteractor().
|
Unit |
onLocalVoiceInteractionStopped()
Callback to indicate that the local voice interaction has stopped either because it was requested through a call to stopLocalVoiceInteraction() or because it was canceled by the user. The previously acquired VoiceInteractor is no longer valid after this.
|
Unit |
onLowMemory()
|
Boolean |
onMenuItemSelected(featureId: Int, item: MenuItem)
Default implementation of android.view.Window.Callback#onMenuItemSelected for activities. This calls through to the new onOptionsItemSelected method for the android.view.Window#FEATURE_OPTIONS_PANEL panel, so that subclasses of Activity don't need to deal with feature codes.
|
Boolean |
onMenuOpened(featureId: Int, menu: Menu)
Called when a panel's menu is opened by the user. This may also be called when the menu is changing from one type to another (for example, from the icon menu to the expanded menu).
|
Unit |
onMultiWindowModeChanged(isInMultiWindowMode: Boolean, newConfig: Configuration!)
Called by the system when the activity changes from fullscreen mode to multi-window mode and visa-versa. This method provides the same configuration that will be sent in the following onConfigurationChanged(android.content.res.Configuration) call after the activity enters this mode.
|
Unit |
onMultiWindowModeChanged(isInMultiWindowMode: Boolean)
Called by the system when the activity changes from fullscreen mode to multi-window mode and visa-versa.
|
Boolean |
onNavigateUp()
This method is called whenever the user chooses to navigate Up within your application's activity hierarchy from the action bar.
If the attribute parentActivityName was specified in the manifest for this activity or an activity-alias to it, default Up navigation will be handled automatically. If any activity along the parent chain requires extra Intent arguments, the Activity subclass should override the method onPrepareNavigateUpTaskStack(android.app.TaskStackBuilder) to supply those arguments.
See Tasks and Back Stack from the developer guide and Navigation from the design guide for more information about navigating within your app.
See the TaskStackBuilder class and the Activity methods getParentActivityIntent(), shouldUpRecreateTask(android.content.Intent), and navigateUpTo(android.content.Intent) for help implementing custom Up navigation. The AppNavigation sample application in the Android SDK is also available for reference.
|
Boolean |
onNavigateUpFromChild(child: Activity!)
This is called when a child activity of this one attempts to navigate up. The default implementation simply calls onNavigateUp() on this activity (the parent).
|
Unit |
onNewIntent(intent: Intent!)
This is called for activities that set launchMode to "singleTop" in their package, or if a client used the Intent#FLAG_ACTIVITY_SINGLE_TOP flag when calling #startActivity. In either case, when the activity is re-launched while at the top of the activity stack instead of a new instance of the activity being started, onNewIntent() will be called on the existing instance with the Intent that was used to re-launch it.
An activity can never receive a new intent in the resumed state. You can count on onResume being called after this method, though not necessarily immediately after the completion of this callback. If the activity was resumed, it will be paused and new intent will be delivered, followed by onResume. If the activity wasn't in the resumed state, then new intent can be delivered immediately, with onResume() called sometime later when activity becomes active again.
Note that getIntent still returns the original Intent. You can use setIntent(android.content.Intent) to update it to this new Intent.
|
Unit |
onNewIntent(intent: Intent, caller: ComponentCaller)
Same as onNewIntent(android.content.Intent), but with an extra parameter for the ComponentCaller instance associated with the app that sent the intent.
If you want to retrieve the caller without overriding this method, call getCurrentCaller inside your existing onNewIntent(android.content.Intent).
Note that you should only override one #onNewIntent method.
|
Boolean |
onOptionsItemSelected(item: MenuItem)
This hook is called whenever an item in your options menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities.
Derived classes should call through to the base class for it to perform the default menu handling.
|
Unit |
onOptionsMenuClosed(menu: Menu!)
This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
|
Unit |
onPanelClosed(featureId: Int, menu: Menu)
Default implementation of android.view.Window.Callback#onPanelClosed(int, Menu) for activities. This calls through to onOptionsMenuClosed(android.view.Menu) method for the android.view.Window#FEATURE_OPTIONS_PANEL panel, so that subclasses of Activity don't need to deal with feature codes. For context menus (Window#FEATURE_CONTEXT_MENU), the onContextMenuClosed(android.view.Menu) will be called.
|
Unit |
onPerformDirectAction(actionId: String, arguments: Bundle, cancellationSignal: CancellationSignal, resultListener: Consumer<Bundle!>)
This is called to perform an action previously defined by the app. Apps also have access to getVoiceInteractor() to follow up on the action.
|
Unit |
onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean, newConfig: Configuration!)
Called by the system when the activity changes to and from picture-in-picture mode. This method provides the same configuration that will be sent in the following onConfigurationChanged(android.content.res.Configuration) call after the activity enters this mode.
|
Unit |
onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)
Called by the system when the activity changes to and from picture-in-picture mode.
|
Boolean |
onPictureInPictureRequested()
This method is called by the system in various cases where picture in picture mode should be entered if supported.
It is up to the app developer to choose whether to call enterPictureInPictureMode(android.app.PictureInPictureParams) at this time. For example, the system will call this method when the activity is being put into the background, so the app developer might want to switch an activity into PIP mode instead.
|
Unit |
onPictureInPictureUiStateChanged(pipState: PictureInPictureUiState)
Called by the system when the activity is in PiP and has state changes. Compare to onPictureInPictureModeChanged(boolean,android.content.res.Configuration), which is only called when PiP mode changes (meaning, enters or exits PiP), this can be called at any time while the activity is in PiP mode. Therefore, all invocation can only happen after onPictureInPictureModeChanged(boolean,android.content.res.Configuration) is called with true, and before onPictureInPictureModeChanged(boolean,android.content.res.Configuration) is called with false. You would not need to worry about cases where this is called and the activity is not in Picture-In-Picture mode. For managing cases where the activity enters/exits Picture-in-Picture (e.g. resources clean-up on exit), use onPictureInPictureModeChanged(boolean,android.content.res.Configuration). The default state is everything declared in PictureInPictureUiState is false, such as PictureInPictureUiState#isStashed().
|
Unit |
onPostCreate(savedInstanceState: Bundle?)
Called when activity start-up is complete (after onStart and #onRestoreInstanceState have been called). Applications will generally not implement this method; it is intended for system classes to do final initialization after application code has run.
Derived classes must call through to the super class's implementation of this method. If they do not, an exception will be thrown.
If you override this method you must call through to the superclass implementation.
|
Unit |
onPostCreate(savedInstanceState: Bundle?, persistentState: PersistableBundle?)
This is the same as onPostCreate(android.os.Bundle) but is called for activities created with the attribute android.R.attr#persistableMode set to persistAcrossReboots.
|
Unit |
onPostResume()
Called when activity resume is complete (after onResume has been called). Applications will generally not implement this method; it is intended for system classes to do final setup after application resume code has run.
Derived classes must call through to the super class's implementation of this method. If they do not, an exception will be thrown.
If you override this method you must call through to the superclass implementation.
|
Unit |
onPrepareDialog(id: Int, dialog: Dialog!)
|
Unit |
onPrepareDialog(id: Int, dialog: Dialog!, args: Bundle!)
Provides an opportunity to prepare a managed dialog before it is being shown. The default implementation calls through to onPrepareDialog(int,android.app.Dialog) for compatibility.
Override this if you need to update a managed dialog based on the state of the application each time it is shown. For example, a time picker dialog might want to be updated with the current time. You should call through to the superclass's implementation. The default implementation will set this Activity as the owner activity on the Dialog.
|
Unit |
onPrepareNavigateUpTaskStack(builder: TaskStackBuilder!)
Prepare the synthetic task stack that will be generated during Up navigation from a different task.
This method receives the TaskStackBuilder with the constructed series of Intents as generated by onCreateNavigateUpTaskStack(android.app.TaskStackBuilder). If any extra data should be added to these intents before launching the new task, the application should override this method and add that data here.
|
Boolean |
onPrepareOptionsMenu(menu: Menu!)
Prepare the Screen's standard options menu to be displayed. This is called right before the menu is shown, every time it is shown. You can use this method to efficiently enable/disable items or otherwise dynamically modify the contents.
The default implementation updates the system menu items based on the activity's state. Deriving classes should always call through to the base class implementation.
|
Boolean |
onPreparePanel(featureId: Int, view: View?, menu: Menu)
Default implementation of android.view.Window.Callback#onPreparePanel for activities. This calls through to the new onPrepareOptionsMenu method for the android.view.Window#FEATURE_OPTIONS_PANEL panel, so that subclasses of Activity don't need to deal with feature codes.
|
Unit |
onProvideAssistContent(outContent: AssistContent!)
This is called when the user is requesting an assist, to provide references to content related to the current activity. Before being called, the outContent Intent is filled with the base Intent of the activity (the Intent returned by getIntent()). The Intent's extras are stripped of any types that are not valid for PersistableBundle or non-framework Parcelables, and the flags Intent#FLAG_GRANT_WRITE_URI_PERMISSION and Intent#FLAG_GRANT_PERSISTABLE_URI_PERMISSION are cleared from the Intent.
Custom implementation may adjust the content intent to better reflect the top-level context of the activity, and fill in its ClipData with additional content of interest that the user is currently viewing. For example, an image gallery application that has launched in to an activity allowing the user to swipe through pictures should modify the intent to reference the current image they are looking it; such an application when showing a list of pictures should add a ClipData that has references to all of the pictures currently visible on screen.
|
Unit |
onProvideAssistData(data: Bundle!)
This is called when the user is requesting an assist, to build a full Intent#ACTION_ASSIST Intent with all of the context of the current application. You can override this method to place into the bundle anything you would like to appear in the Intent#EXTRA_ASSIST_CONTEXT part of the assist Intent.
This function will be called after any global assist callbacks that had been registered with Application.registerOnProvideAssistDataListener.
|
Unit |
onProvideKeyboardShortcuts(data: MutableList<KeyboardShortcutGroup!>!, menu: Menu?, deviceId: Int)
|
Uri! |
onProvideReferrer()
Override to generate the desired referrer for the content currently being shown by the app. The default implementation returns null, meaning the referrer will simply be the android-app: of the package name of this activity. Return a non-null Uri to have that supplied as the Intent#EXTRA_REFERRER of any activities started from it.
|
Unit |
onRequestPermissionsResult(requestCode: Int, permissions: Array<String!>, grantResults: IntArray)
Callback for the result from requesting permissions. This method is invoked for every call on #requestPermissions
Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation.
|
Unit |
onRequestPermissionsResult(requestCode: Int, permissions: Array<String!>, grantResults: IntArray, deviceId: Int)
Callback for the result from requesting permissions. This method is invoked for every call on #requestPermissions.
Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation.
|
Unit |
onRestart()
Called after onStop when the current activity is being re-displayed to the user (the user has navigated back to it). It will be followed by onStart and then onResume.
For activities that are using raw Cursor objects (instead of creating them through managedQuery(android.net.Uri,java.lang.String[],java.lang.String,java.lang.String[],java.lang.String), this is usually the place where the cursor should be requeried (because you had deactivated it in onStop.
Derived classes must call through to the super class's implementation of this method. If they do not, an exception will be thrown.
If you override this method you must call through to the superclass implementation.
|
Unit |
onRestoreInstanceState(savedInstanceState: Bundle)
This method is called after onStart when the activity is being re-initialized from a previously saved state, given here in savedInstanceState. Most implementations will simply use #onCreate to restore their state, but it is sometimes convenient to do it here after all of the initialization has been done or to allow subclasses to decide whether to use your default implementation. The default implementation of this method performs a restore of any view state that had previously been frozen by #onSaveInstanceState.
This method is called between onStart and #onPostCreate. This method is called only when recreating an activity; the method isn't invoked if onStart is called for any other reason.
|
Unit |
onRestoreInstanceState(savedInstanceState: Bundle?, persistentState: PersistableBundle?)
This is the same as onRestoreInstanceState(android.os.Bundle) but is called for activities created with the attribute android.R.attr#persistableMode set to persistAcrossReboots. The android.os.PersistableBundle passed came from the restored PersistableBundle first saved in onSaveInstanceState(android.os.Bundle,android.os.PersistableBundle).
This method is called between onStart and #onPostCreate.
If this method is called onRestoreInstanceState(android.os.Bundle) will not be called.
At least one of savedInstanceState or persistentState will not be null.
|
Any! |
onRetainNonConfigurationInstance()
Called by the system, as part of destroying an activity due to a configuration change, when it is known that a new instance will immediately be created for the new configuration. You can return any object you like here, including the activity instance itself, which can later be retrieved by calling getLastNonConfigurationInstance() in the new activity instance. If you are targeting android.os.Build.VERSION_CODES#HONEYCOMB or later, consider instead using a Fragment with Fragment.setRetainInstance(boolean.
This function is called purely as an optimization, and you must not rely on it being called. When it is called, a number of guarantees will be made to help optimize configuration switching:
- The function will be called between
onStop and onDestroy.
- A new instance of the activity will always be immediately created after this one's
onDestroy() is called. In particular, no messages will be dispatched during this time (when the returned object does not have an activity to be associated with).
- The object you return here will always be available from the
getLastNonConfigurationInstance() method of the following activity instance as described there.
These guarantees are designed so that an activity can use this API to propagate extensive state from the old to new activity instance, from loaded bitmaps, to network connections, to evenly actively running threads. Note that you should not propagate any data that may change based on the configuration, including any data loaded from resources such as strings, layouts, or drawables.
The guarantee of no message handling during the switch to the next activity simplifies use with active objects. For example if your retained state is an android.os.AsyncTask you are guaranteed that its call back functions (like android.os.AsyncTask#onPostExecute) will not be called from the call here until you execute the next instance's onCreate(android.os.Bundle). (Note however that there is of course no such guarantee for android.os.AsyncTask#doInBackground since that is running in a separate thread.)
Note: For most cases you should use the Fragment API Fragment#setRetainInstance(boolean) instead; this is also available on older platforms through the Android support libraries.
|
Unit |
onSaveInstanceState(outState: Bundle, outPersistentState: PersistableBundle)
This is the same as #onSaveInstanceState but is called for activities created with the attribute android.R.attr#persistableMode set to persistAcrossReboots. The android.os.PersistableBundle passed in will be saved and presented in onCreate(android.os.Bundle,android.os.PersistableBundle) the first time that this activity is restarted following the next device reboot.
|
Boolean |
onSearchRequested(searchEvent: SearchEvent?)
This hook is called when the user signals the desire to start a search.
You can use this function as a simple way to launch the search UI, in response to a menu item, search button, or other widgets within your activity. Unless overridden, calling this function is the same as calling startSearch(null,false,null,false), which launches search for the current activity as specified in its manifest, see SearchManager.
You can override this function to force global search, e.g. in response to a dedicated search key, or to block search entirely (by simply returning false).
Note: when running in a Configuration#UI_MODE_TYPE_TELEVISION or Configuration#UI_MODE_TYPE_WATCH, the default implementation changes to simply return false and you must supply your own custom implementation if you want to support search.
|
Boolean |
onSearchRequested()
|
Unit |
onStart()
Called after #onCreate — or after onRestart when the activity had been stopped, but is now again being displayed to the user. It will usually be followed by onResume. This is a good place to begin drawing visual elements, running animations, etc.
You can call finish from within this function, in which case onStop will be immediately called after onStart without the lifecycle transitions in-between (onResume, onPause, etc) executing.
Derived classes must call through to the super class's implementation of this method. If they do not, an exception will be thrown.
If you override this method you must call through to the superclass implementation.
|
Unit |
onStateNotSaved()
Called when an onResume is coming up, prior to other pre-resume callbacks such as #onNewIntent and #onActivityResult. This is primarily intended to give the activity a hint that its state is no longer saved -- it will generally be called after #onSaveInstanceState and prior to the activity being resumed/started again.
|
Unit |
onTitleChanged(title: CharSequence!, color: Int)
|
Unit |
onTopResumedActivityChanged(isTopResumedActivity: Boolean)
Called when activity gets or loses the top resumed position in the system.
Starting with android.os.Build.VERSION_CODES#Q multiple activities can be resumed at the same time in multi-window and multi-display modes. This callback should be used instead of onResume() as an indication that the activity can try to open exclusive-access devices like camera.
It will always be delivered after the activity was resumed and before it is paused. In some cases it might be skipped and activity can go straight from onResume() to onPause() without receiving the top resumed state.
|
Boolean |
onTouchEvent(event: MotionEvent!)
Called when a touch screen event was not handled by any of the views inside of the activity. This is most useful to process touch events that happen outside of your window bounds, where there is no view to receive it.
|
Boolean |
onTrackballEvent(event: MotionEvent!)
Called when the trackball was moved and not handled by any of the views inside of the activity. So, for example, if the trackball moves while focus is on a button, you will receive a call here because buttons do not normally do anything with trackball events. The call here happens before trackball movements are converted to DPAD key events, which then get sent back to the view hierarchy, and will be processed at the point for things like focus navigation.
|
Unit |
onTrimMemory(level: Int)
|
Unit |
onUserInteraction()
Called 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 callback and onUserLeaveHint are intended to help activities manage status bar notifications intelligently; specifically, for helping activities determine the proper time to cancel a notification.
All calls to your activity's onUserLeaveHint callback will be accompanied by calls to onUserInteraction. 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.
|
Unit |
onUserLeaveHint()
Called as part of the activity lifecycle when an activity is about to go into the background as the result of user choice. For example, when the user presses the Home key, onUserLeaveHint will be called, but when an incoming phone call causes the in-call Activity to be automatically brought to the foreground, onUserLeaveHint will not be called on the activity being interrupted. In cases when it is invoked, this method is called right before the activity's onPause callback.
This callback and onUserInteraction are intended to help activities manage status bar notifications intelligently; specifically, for helping activities determine the proper time to cancel a notification.
|
Unit |
onVisibleBehindCanceled()
Called when a translucent activity over this activity is becoming opaque or another activity is being launched. Activities that override this method must call super.onVisibleBehindCanceled() or a SuperNotCalledException will be thrown.
When this method is called the activity has 500 msec to release any resources it may be using while visible in the background. If the activity has not returned from this method in 500 msec the system will destroy the activity and kill the process in order to recover the resources for another process. Otherwise onStop() will be called following return.
If you override this method you must call through to the superclass implementation.
|
Unit |
onWindowAttributesChanged(params: WindowManager.LayoutParams!)
|
Unit |
onWindowFocusChanged(hasFocus: Boolean)
Called when the current Window of the activity gains or loses focus. This is the best indicator of whether this activity is the entity with which the user actively interacts. The default implementation clears the key tracking state, so should always be called.
Note that this provides information about global focus state, which is managed independently of activity lifecycle. As such, while focus changes will generally have some relation to lifecycle changes (an activity that is stopped will not generally get window focus), you should not rely on any particular order between the callbacks here and those in the other lifecycle methods such as onResume.
As a general rule, however, a foreground activity will have window focus... unless it has displayed other dialogs or popups that take input focus, in which case the activity itself will not have focus when the other windows have it. Likewise, the system may display system-level windows (such as the status bar notification panel or a system alert) which will temporarily take window input focus without pausing the foreground activity.
Starting with android.os.Build.VERSION_CODES#Q there can be multiple resumed activities at the same time in multi-window mode, so resumed state does not guarantee window focus even if there are no overlays above.
If the intent is to know when an activity is the topmost active, the one the user interacted with last among all activities but not including non-activity windows like dialogs and popups, then onTopResumedActivityChanged(boolean) should be used. On platform versions prior to android.os.Build.VERSION_CODES#Q, onResume is the best indicator.
|
ActionMode? |
onWindowStartingActionMode(callback: ActionMode.Callback!)
Give the Activity a chance to control the UI for an action mode requested by the system.
Note: If you are looking for a notification callback that an action mode has been started for this activity, see onActionModeStarted(android.view.ActionMode).
|
ActionMode? |
onWindowStartingActionMode(callback: ActionMode.Callback!, type: Int)
Called when an action mode is being started for this window. Gives the callback an opportunity to handle the action mode in its own unique and beautiful way. If this method returns null the system can choose a way to present the mode or choose not to start the mode at all.
|
Unit |
openContextMenu(view: View!)
Programmatically opens the context menu for a particular view. The view should have been added via registerForContextMenu(android.view.View).
|
Unit |
openOptionsMenu()
Programmatically opens the options menu. If the options menu is already open, this method does nothing.
|
Unit |
overrideActivityTransition(overrideType: Int, enterAnim: Int, exitAnim: Int)
Customizes the animation for the activity transition with this activity. This can be called at any time while the activity still alive.
This is a more robust method of overriding the transition animation at runtime without relying on overridePendingTransition(int,int) which doesn't work for predictive back. However, the animation set from overridePendingTransition(int,int) still has higher priority when the system is looking for the next transition animation.
The animations resources set by this method will be chosen if and only if the activity is on top of the task while activity transitions are being played. For example, if we want to customize the opening transition when launching Activity B which gets started from Activity A, we should call this method inside B's onCreate with overrideType = OVERRIDE_TRANSITION_OPEN because the Activity B will on top of the task. And if we want to customize the closing transition when finishing Activity B and back to Activity A, since B is still is above A, we should call this method in Activity B with overrideType = OVERRIDE_TRANSITION_CLOSE.
If an Activity has called this method, and it also set another activity animation by Window#setWindowAnimations(int), the system will choose the animation set from this method.
Note that Window#setWindowAnimations, overridePendingTransition(int,int) and this method will be ignored if the Activity is started with ActivityOptions#makeSceneTransitionAnimation(Activity, Pair[]). Also note that this method can only be used to customize cross-activity transitions but not cross-task transitions which are fully non-customizable as of Android 11.
|
Unit |
overrideActivityTransition(overrideType: Int, enterAnim: Int, exitAnim: Int, backgroundColor: Int)
Customizes the animation for the activity transition with this activity. This can be called at any time while the activity still alive.
This is a more robust method of overriding the transition animation at runtime without relying on overridePendingTransition(int,int) which doesn't work for predictive back. However, the animation set from overridePendingTransition(int,int) still has higher priority when the system is looking for the next transition animation.
The animations resources set by this method will be chosen if and only if the activity is on top of the task while activity transitions are being played. For example, if we want to customize the opening transition when launching Activity B which gets started from Activity A, we should call this method inside B's onCreate with overrideType = OVERRIDE_TRANSITION_OPEN because the Activity B will on top of the task. And if we want to customize the closing transition when finishing Activity B and back to Activity A, since B is still is above A, we should call this method in Activity B with overrideType = OVERRIDE_TRANSITION_CLOSE.
If an Activity has called this method, and it also set another activity animation by Window#setWindowAnimations(int), the system will choose the animation set from this method.
Note that Window#setWindowAnimations, overridePendingTransition(int,int) and this method will be ignored if the Activity is started with ActivityOptions#makeSceneTransitionAnimation(Activity, Pair[]). Also note that this method can only be used to customize cross-activity transitions but not cross-task transitions which are fully non-customizable as of Android 11.
|
Unit |
overridePendingTransition(enterAnim: Int, exitAnim: Int)
Call immediately after one of the flavors of #startActivity(android.content.Intent) or finish to specify an explicit transition animation to perform next.
As of android.os.Build.VERSION_CODES#JELLY_BEAN an alternative to using this with starting activities is to supply the desired animation information through a ActivityOptions bundle to #startActivity(android.content.Intent,android.os.Bundle) or a related function. This allows you to specify a custom animation even when starting an activity from outside the context of the current top activity.
Af of android.os.Build.VERSION_CODES#S application can only specify a transition animation when the transition happens within the same task. System default animation is used for cross-task transition animations.
|
Unit |
overridePendingTransition(enterAnim: Int, exitAnim: Int, backgroundColor: Int)
Call immediately after one of the flavors of #startActivity(android.content.Intent) or finish to specify an explicit transition animation to perform next.
As of android.os.Build.VERSION_CODES#JELLY_BEAN an alternative to using this with starting activities is to supply the desired animation information through a ActivityOptions bundle to #startActivity(android.content.Intent,android.os.Bundle) or a related function. This allows you to specify a custom animation even when starting an activity from outside the context of the current top activity.
|
Unit |
postponeEnterTransition()
Postpone the entering activity transition when Activity was started with android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.util.Pair[]).
This method gives the Activity the ability to delay starting the entering and shared element transitions until all data is loaded. Until then, the Activity won't draw into its window, leaving the window transparent. This may also cause the returning animation to be delayed until data is ready. This method should be called in onCreate(android.os.Bundle) or in onActivityReenter(int,android.content.Intent). startPostponedEnterTransition() must be called to allow the Activity to start the transitions. If the Activity did not use android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.util.Pair[]), then this method does nothing.
|
Unit |
recreate()
Cause this Activity to be recreated with a new instance. This results in essentially the same flow as when the Activity is created due to a configuration change -- the current instance will go through its lifecycle to onDestroy and a new instance then created after it.
|
Unit |
registerActivityLifecycleCallbacks(callback: Application.ActivityLifecycleCallbacks)
Register an Application.ActivityLifecycleCallbacks instance that receives lifecycle callbacks for only this Activity.
In relation to any Application registered callbacks, the callbacks registered here will always occur nested within those callbacks. This means:
If multiple callbacks are registered here, they receive events in a first in (up through Application.ActivityLifecycleCallbacks#onActivityPostResumed, last out ordering.
It is strongly recommended to register this in the constructor of your Activity to ensure you get all available callbacks. As this callback is associated with only this Activity, it is not usually necessary to unregister it unless you specifically do not want to receive further lifecycle callbacks.
|
Unit |
registerComponentCallbacks(callback: ComponentCallbacks!)
|
Unit |
registerForContextMenu(view: View!)
Registers a context menu to be shown for the given view (multiple views can show the context menu). This method will set the OnCreateContextMenuListener on the view to this activity, so onCreateContextMenu(android.view.ContextMenu,android.view.View,android.view.ContextMenu.ContextMenuInfo) will be called when it is time to show the context menu.
|
Unit |
registerScreenCaptureCallback(executor: Executor, callback: Activity.ScreenCaptureCallback)
Registers a screen capture callback for this activity. The callback will be triggered when a screen capture of this activity is attempted. This callback will be executed on the thread of the passed executor. For details, see ScreenCaptureCallback#onScreenCaptured.
Requires android.Manifest.permission#DETECT_SCREEN_CAPTURE
|
Boolean |
releaseInstance()
Ask that the local app instance of this activity be released to free up its memory. This is asking for the activity to be destroyed, but does not finish the activity -- a new instance of the activity will later be re-created if needed due to the user navigating back to it.
|
Unit |
removeDialog(id: Int)
Removes any internal references to a dialog managed by this Activity. If the dialog is showing, it will dismiss it as part of the clean up.
This can be useful if you know that you will never show a dialog again and want to avoid the overhead of saving and restoring it in the future.
As of android.os.Build.VERSION_CODES#GINGERBREAD, this function will not throw an exception if you try to remove an ID that does not currently have an associated dialog.
|
Unit |
reportFullyDrawn()
Report to the system that your app is now fully drawn, for diagnostic and optimization purposes. The system may adjust optimizations to prioritize work that happens before reportFullyDrawn is called, to improve app startup. Misrepresenting the startup window by calling reportFullyDrawn too late or too early may decrease application and startup performance.
This is also used to help instrument application launch times, so that the app can report when it is fully in a usable state; without this, the only thing the system itself can determine is the point at which the activity's window is first drawn and displayed. To participate in app launch time measurement, you should always call this method after first launch (when onCreate(android.os.Bundle) is called), at the point where you have entirely drawn your UI and populated with all of the significant data. You can safely call this method any time after first launch as well, in which case it will simply be ignored.
If this method is called before the activity's window is first drawn and displayed as measured by the system, the reported time here will be shifted to the system measured time.
|
DragAndDropPermissions! |
requestDragAndDropPermissions(event: DragEvent!)
Create DragAndDropPermissions object bound to this activity and controlling the access permissions for content URIs associated with the DragEvent.
|
Unit |
requestFullscreenMode(request: Int, approvalCallback: OutcomeReceiver<Void!, Throwable!>?)
Request to put the activity into fullscreen. The requester must be pinned or the top-most activity of the focused display which can be verified using onTopResumedActivityChanged(boolean). The request should also be a response to a user input. When getting fullscreen and receiving corresponding onConfigurationChanged(android.content.res.Configuration) and onMultiWindowModeChanged(boolean,android.content.res.Configuration), the activity should relayout itself and the system bars' visibilities can be controlled as usual fullscreen apps. Calling it again with the exit request can restore the activity to the previous status. This will only happen when it got into fullscreen through this API.
|
Unit |
requestPermissions(permissions: Array<String!>, requestCode: Int)
Requests permissions to be granted to this application. These permissions must be requested in your manifest, they should not be granted to your app, and they should have protection level dangerous, regardless whether they are declared by the platform or a third-party app.
Normal permissions android.content.pm.PermissionInfo#PROTECTION_NORMAL are granted at install time if requested in the manifest. Signature permissions android.content.pm.PermissionInfo#PROTECTION_SIGNATURE are granted at install time if requested in the manifest and the signature of your app matches the signature of the app declaring the permissions.
Call #shouldShowRequestPermissionRationale before calling this API to check if the system recommends to show a rationale UI before asking for a permission.
If your app does not have the requested permissions the user will be presented with UI for accepting them. After the user has accepted or rejected the requested permissions you will receive a callback on #onRequestPermissionsResult reporting whether the permissions were granted or not.
Note that requesting a permission does not guarantee it will be granted and your app should be able to run without having this permission.
This method may start an activity allowing the user to choose which permissions to grant and which to reject. Hence, you should be prepared that your activity may be paused and resumed. Further, granting some permissions may require a restart of you application. In such a case, the system will recreate the activity stack before delivering the result to #onRequestPermissionsResult.
When checking whether you have a permission you should use checkSelfPermission(java.lang.String).
You cannot request a permission if your activity sets noHistory to true because in this case the activity would not receive result callbacks including #onRequestPermissionsResult.
The permissions samples repo demonstrates how to use this method to request permissions at run time.
|
Unit |
requestPermissions(permissions: Array<String!>, requestCode: Int, deviceId: Int)
Requests permissions to be granted to this application. These permissions must be requested in your manifest, they should not be granted to your app, and they should have protection level dangerous, regardless whether they are declared by the platform or a third-party app.
Normal permissions android.content.pm.PermissionInfo#PROTECTION_NORMAL are granted at install time if requested in the manifest. Signature permissions android.content.pm.PermissionInfo#PROTECTION_SIGNATURE are granted at install time if requested in the manifest and the signature of your app matches the signature of the app declaring the permissions.
Call #shouldShowRequestPermissionRationale before calling this API to check if the system recommends to show a rationale UI before asking for a permission.
If your app does not have the requested permissions the user will be presented with UI for accepting them. After the user has accepted or rejected the requested permissions you will receive a callback on #onRequestPermissionsResult reporting whether the permissions were granted or not.
Note that requesting a permission does not guarantee it will be granted and your app should be able to run without having this permission.
This method may start an activity allowing the user to choose which permissions to grant and which to reject. Hence, you should be prepared that your activity may be paused and resumed. Further, granting some permissions may require a restart of you application. In such a case, the system will recreate the activity stack before delivering the result to #onRequestPermissionsResult.
When checking whether you have a permission you should use checkSelfPermission(java.lang.String).
You cannot request a permission if your activity sets noHistory to true because in this case the activity would not receive result callbacks including #onRequestPermissionsResult.
The permissions samples repo demonstrates how to use this method to request permissions at run time.
|
Unit |
requestShowKeyboardShortcuts()
Request the Keyboard Shortcuts screen to show up. This will trigger onProvideKeyboardShortcuts to retrieve the shortcuts for the foreground activity.
|
Boolean |
requestVisibleBehind(visible: Boolean)
Activities that want to remain visible behind a translucent activity above them must call this method anytime between the start of onResume() and the return from onPause(). If this call is successful then the activity will remain visible after onPause() is called, and is allowed to continue playing media in the background.
The actions of this call are reset each time that this activity is brought to the front. That is, every time onResume() is called the activity will be assumed to not have requested visible behind. Therefore, if you want this activity to continue to be visible in the background you must call this method again.
Only fullscreen opaque activities may make this call. I.e. this call is a nop for dialog and translucent activities.
Under all circumstances, the activity must stop playing and release resources prior to or within a call to onVisibleBehindCanceled() or if this call returns false.
False will be returned any time this method is called between the return of onPause and the next call to onResume.
|
Boolean |
requestWindowFeature(featureId: Int)
Enable extended window features. This is a convenience for calling getWindow().requestFeature().
|
T |
requireViewById(id: Int)
Finds a view that was identified by the android:id XML attribute that was processed in #onCreate, or throws an IllegalArgumentException if the ID is invalid, or there is no matching view in the hierarchy.
Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.
|
Unit |
runOnUiThread(action: Runnable!)
Runs the specified action on the UI thread. If the current thread is the UI thread, then the action is executed immediately. If the current thread is not the UI thread, the action is posted to the event queue of the UI thread.
|
Unit |
setActionBar(toolbar: Toolbar?)
Set a Toolbar to act as the ActionBar for this Activity window.
When set to a non-null value the getActionBar() method will return an ActionBar object that can be used to control the given toolbar as if it were a traditional window decor action bar. The toolbar's menu will be populated with the Activity's options menu and the navigation button will be wired through the standard home menu select action.
In order to use a Toolbar within the Activity's window content the application must not request the window feature FEATURE_ACTION_BAR.
|
Unit |
setAllowCrossUidActivitySwitchFromBelow(allowed: Boolean)
Specifies whether the activities below this one in the task can also start other activities or finish the task.
Starting from Target SDK Level android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM, apps may be blocked from starting new activities or finishing their task unless the top activity of such task belong to the same UID for security reasons.
Setting this flag to true will allow the launching app to ignore the restriction if this activity is on top. Apps matching the UID of this activity are always exempt.
|
Unit |
setContentTransitionManager(tm: TransitionManager!)
Set the TransitionManager to use for default transitions in this window. Requires Window#FEATURE_CONTENT_TRANSITIONS.
|
Unit |
setContentView(layoutResID: Int)
Set the activity content from a layout resource. The resource will be inflated, adding all top-level views to the activity.
|
Unit |
setContentView(view: View!)
Set the activity content to an explicit view. This view is placed directly into the activity's view hierarchy. It can itself be a complex view hierarchy. When calling this method, the layout parameters of the specified view are ignored. Both the width and the height of the view are set by default to ViewGroup.LayoutParams#MATCH_PARENT. To use your own layout parameters, invoke setContentView(android.view.View,android.view.ViewGroup.LayoutParams) instead.
|
Unit |
setContentView(view: View!, params: ViewGroup.LayoutParams!)
Set the activity content to an explicit view. This view is placed directly into the activity's view hierarchy. It can itself be a complex view hierarchy.
|
Unit |
setDefaultKeyMode(mode: Int)
Select the default key handling for this activity. This controls what will happen to key events that are not otherwise handled. The default mode (DEFAULT_KEYS_DISABLE) will simply drop them on the floor. Other modes allow you to launch the dialer (DEFAULT_KEYS_DIALER), execute a shortcut in your options menu without requiring the menu key be held down (DEFAULT_KEYS_SHORTCUT), or launch a search (DEFAULT_KEYS_SEARCH_LOCAL and DEFAULT_KEYS_SEARCH_GLOBAL).
Note that the mode selected here does not impact the default handling of system keys, such as the "back" and "menu" keys, and your activity and its views always get a first chance to receive and handle all application keys.
|
Unit |
setEnterSharedElementCallback(callback: SharedElementCallback!)
When android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.view.View, String) was used to start an Activity, callback will be called to handle shared elements on the launched Activity. This requires Window#FEATURE_ACTIVITY_TRANSITIONS.
|
Unit |
setExitSharedElementCallback(callback: SharedElementCallback!)
When android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.view.View, String) was used to start an Activity, callback will be called to handle shared elements on the launching Activity. Most calls will only come when returning from the started Activity. This requires Window#FEATURE_ACTIVITY_TRANSITIONS.
|
Unit |
setFeatureDrawable(featureId: Int, drawable: Drawable!)
Convenience for calling android.view.Window#setFeatureDrawable(int, Drawable).
|
Unit |
setFeatureDrawableAlpha(featureId: Int, alpha: Int)
Convenience for calling android.view.Window#setFeatureDrawableAlpha.
|
Unit |
setFeatureDrawableResource(featureId: Int, resId: Int)
Convenience for calling android.view.Window#setFeatureDrawableResource.
|
Unit |
setFeatureDrawableUri(featureId: Int, uri: Uri!)
Convenience for calling android.view.Window#setFeatureDrawableUri.
|
Unit |
setFinishOnTouchOutside(finish: Boolean)
Sets whether this activity is finished when touched outside its window's bounds.
|
Unit |
setImmersive(i: Boolean)
Adjust the current immersive mode setting. Note that changing this value will have no effect on the activity's android.content.pm.ActivityInfo structure; that is, if android:immersive is set to true in the application's manifest entry for this activity, the ActivityInfo.flags member will always have its FLAG_IMMERSIVE bit set.
|
Unit |
setInheritShowWhenLocked(inheritShowWhenLocked: Boolean)
Specifies whether this Activity should be shown on top of the lock screen whenever the lockscreen is up and this activity has another activity behind it with the showWhenLock attribute set. That is, this activity is only visible on the lock screen if there is another activity with the showWhenLock attribute visible at the same time on the lock screen. A use case for this is permission dialogs, that should only be visible on the lock screen if their requesting activity is also visible. This value can be set as a manifest attribute using android.R.attr#inheritShowWhenLocked.
|
Unit |
setIntent(newIntent: Intent!)
Changes the intent returned by getIntent. This holds a reference to the given intent; it does not copy it. Often used in conjunction with onNewIntent(android.content.Intent).
|
Unit |
setIntent(newIntent: Intent?, newCaller: ComponentCaller?)
Changes the intent returned by getIntent, and ComponentCaller returned by getCaller. This holds references to the given intent, and ComponentCaller; it does not copy them. Often used in conjunction with onNewIntent(android.content.Intent). To retrieve the caller from onNewIntent(android.content.Intent), use getCurrentCaller, otherwise override onNewIntent(android.content.Intent,android.app.ComponentCaller).
|
Unit |
setLocusContext(locusId: LocusId?, bundle: Bundle?)
Sets the android.content.LocusId for this activity. The locus id helps identify different instances of the same Activity class.
For example, a locus id based on a specific conversation could be set on a conversation app's chat Activity. The system can then use this locus id along with app's contents to provide ranking signals in various UI surfaces including sharing, notifications, shortcuts and so on.
It is recommended to set the same locus id in the shortcut's locus id using setLocusId so that the system can learn appropriate ranking signals linking the activity's locus id with the matching shortcut.
|
Unit |
setMediaController(controller: MediaController!)
Sets a MediaController to send media keys and volume changes to.
The controller will be tied to the window of this Activity. Media key and volume events which are received while the Activity is in the foreground will be forwarded to the controller and used to invoke transport controls or adjust the volume. This may be used instead of or in addition to setVolumeControlStream to affect a specific session instead of a specific stream.
It is not guaranteed that the hardware volume controls will always change this session's volume (for example, if a call is in progress, its stream's volume may be changed instead). To reset back to the default use null as the controller.
|
Unit |
setPictureInPictureParams(params: PictureInPictureParams)
Updates the properties of the picture-in-picture activity, or sets it to be used later when enterPictureInPictureMode() is called.
|
Unit |
setProgress(progress: Int)
Sets the progress for the progress bars in the title.
In order for the progress bar to be shown, the feature must be requested via requestWindowFeature(int).
|
Unit |
setProgressBarIndeterminate(indeterminate: Boolean)
Sets whether the horizontal progress bar in the title should be indeterminate (the circular is always indeterminate).
In order for the progress bar to be shown, the feature must be requested via requestWindowFeature(int).
|
Unit |
setProgressBarIndeterminateVisibility(visible: Boolean)
Sets the visibility of the indeterminate progress bar in the title.
In order for the progress bar to be shown, the feature must be requested via requestWindowFeature(int).
|
Unit |
setProgressBarVisibility(visible: Boolean)
Sets the visibility of the progress bar in the title.
In order for the progress bar to be shown, the feature must be requested via requestWindowFeature(int).
|
Unit |
setRecentsScreenshotEnabled(enabled: Boolean)
If set to false, this indicates to the system that it should never take a screenshot of the activity to be used as a representation in recents screen. By default, this value is true.
Note that the system may use the window background of the theme instead to represent the window when it is not running.
Also note that in comparison to android.view.WindowManager.LayoutParams#FLAG_SECURE, this only affects the behavior when the activity's screenshot would be used as a representation when the activity is not in a started state, i.e. in Overview. The system may still take screenshots of the activity in other contexts; for example, when the user takes a screenshot of the entire screen, or when the active android.service.voice.VoiceInteractionService requests a screenshot via android.service.voice.VoiceInteractionSession#SHOW_WITH_SCREENSHOT.
|
Unit |
setRequestedOrientation(requestedOrientation: Int)
Change the desired orientation of this activity. If the activity is currently in the foreground or otherwise impacting the screen orientation, the screen will immediately be changed (possibly causing the activity to be restarted). Otherwise, this will be used the next time the activity is visible. Note: Device manufacturers can configure devices to override (ignore) calls to this method to improve the layout of orientation-restricted apps. See Device compatibility mode.
|
Unit |
setResult(resultCode: Int)
Call this to set the result that your activity will return to its caller.
|
Unit |
setResult(resultCode: Int, data: Intent!)
Call this to set the result that your activity will return to its caller.
As of android.os.Build.VERSION_CODES#GINGERBREAD, the Intent you supply here can have Intent.FLAG_GRANT_READ_URI_PERMISSION and/or Intent.FLAG_GRANT_WRITE_URI_PERMISSION set. This will grant the Activity receiving the result access to the specific URIs in the Intent. Access will remain until the Activity has finished (it will remain across the hosting process being killed and other temporary destruction) and will be added to any existing set of URI permissions it already holds.
|
Unit |
setSecondaryProgress(secondaryProgress: Int)
Sets the secondary progress for the progress bar in the title. This progress is drawn between the primary progress (set via setProgress(int) and the background. It can be ideal for media scenarios such as showing the buffering progress while the default progress shows the play progress.
In order for the progress bar to be shown, the feature must be requested via requestWindowFeature(int).
|
Unit |
setShouldDockBigOverlays(shouldDockBigOverlays: Boolean)
Specifies a preference to dock big overlays like the expanded picture-in-picture on TV (see PictureInPictureParams.Builder#setExpandedAspectRatio). Docking puts the big overlay side-by-side next to this activity, so that both windows are fully visible to the user.
If unspecified, whether the overlay window will be docked or not, will be defined by the system.
If specified, the system will try to respect the preference, but it may be overridden by a user preference.
|
Unit |
setShowWhenLocked(showWhenLocked: Boolean)
Specifies whether an Activity should be shown on top of the lock screen whenever the lockscreen is up and the activity is resumed. Normally an activity will be transitioned to the stopped state if it is started while the lockscreen is up, but with this flag set the activity will remain in the resumed state visible on-top of the lock screen. This value can be set as a manifest attribute using android.R.attr#showWhenLocked.
|
Unit |
setTaskDescription(taskDescription: ActivityManager.TaskDescription!)
Sets information describing the task with this activity for presentation inside the Recents System UI. When ActivityManager#getRecentTasks is called, the activities of each task are traversed in order from the topmost activity to the bottommost. The traversal continues for each property until a suitable value is found. For each task the taskDescription will be returned in android.app.ActivityManager.TaskDescription.
|
Unit |
setTheme(resid: Int)
|
Unit |
setTitle(title: CharSequence!)
Change the title associated with this activity. If this is a top-level activity, the title for its window will change. If it is an embedded activity, the parent can do whatever it wants with it.
|
Unit |
setTitle(titleId: Int)
Change the title associated with this activity. If this is a top-level activity, the title for its window will change. If it is an embedded activity, the parent can do whatever it wants with it.
|
Unit |
setTitleColor(textColor: Int)
Change the color of the title associated with this activity.
This method is deprecated starting in API Level 11 and replaced by action bar styles. For information on styling the Action Bar, read the Action Bar developer guide.
|
Boolean |
setTranslucent(translucent: Boolean)
Convert an activity, which particularly with android.R.attr#windowIsTranslucent or android.R.attr#windowIsFloating attribute, to a fullscreen opaque activity, or convert it from opaque back to translucent.
|
Unit |
setTurnScreenOn(turnScreenOn: Boolean)
Specifies whether the screen should be turned on when the Activity is resumed. Normally an activity will be transitioned to the stopped state if it is started while the screen if off, but with this flag set the activity will cause the screen to turn on if the activity will be visible and resumed due to the screen coming on. The screen will not be turned on if the activity won't be visible after the screen is turned on. This flag is normally used in conjunction with the android.R.attr#showWhenLocked flag to make sure the activity is visible after the screen is turned on when the lockscreen is up. In addition, if this flag is set and the activity calls android.app.KeyguardManager#requestDismissKeyguard(android.app.Activity,android.app.KeyguardManager.KeyguardDismissCallback) the screen will turn on.
|
Unit |
setVisible(visible: Boolean)
Control whether this activity's main window is visible. This is intended only for the special case of an activity that is not going to show a UI itself, but can't just finish prior to onResume() because it needs to wait for a service binding or such. Setting this to false allows you to prevent your UI from being shown during that time.
The default value for this is taken from the android.R.attr#windowNoDisplay attribute of the activity's theme.
|
Unit |
setVolumeControlStream(streamType: Int)
Suggests an audio stream whose volume should be changed by the hardware volume controls.
The suggested audio stream will be tied to the window of this Activity. Volume requests which are received while the Activity is in the foreground will affect this stream.
It is not guaranteed that the hardware volume controls will always change this stream's volume (for example, if a call is in progress, its stream's volume may be changed instead). To reset back to the default, use AudioManager#USE_DEFAULT_STREAM_TYPE.
|
Unit |
setVrModeEnabled(enabled: Boolean, requestedComponent: ComponentName)
Enable or disable virtual reality (VR) mode for this Activity.
VR mode is a hint to Android system to switch to a mode optimized for VR applications while this Activity has user focus.
It is recommended that applications additionally declare android.R.attr#enableVrMode in their manifest to allow for smooth activity transitions when switching between VR activities.
If the requested android.service.vr.VrListenerService component is not available, VR mode will not be started. Developers can handle this case as follows:
String servicePackage = "com.whatever.app";
String serviceClass = "com.whatever.app.MyVrListenerService";
// Name of the component of the VrListenerService to start.
ComponentName serviceComponent = new ComponentName(servicePackage, serviceClass);
try {
setVrModeEnabled(true, myComponentName);
} catch (PackageManager.NameNotFoundException e) {
List<ApplicationInfo> installed = getPackageManager().getInstalledApplications(0);
boolean isInstalled = false;
for (ApplicationInfo app : installed) {
if (app.packageName.equals(servicePackage)) {
isInstalled = true;
break;
}
}
if (isInstalled) {
// Package is installed, but not enabled in Settings. Let user enable it.
startActivity(new Intent(Settings.ACTION_VR_LISTENER_SETTINGS));
} else {
// Package is not installed. Send an intent to download this.
sentIntentToLaunchAppStore(servicePackage);
}
}
|
Boolean |
shouldDockBigOverlays()
Returns whether big overlays should be docked next to the activity as set by setShouldDockBigOverlays.
|
Boolean |
shouldShowRequestPermissionRationale(permission: String)
Gets whether you should show UI with rationale before requesting a permission.
|
Boolean |
shouldShowRequestPermissionRationale(permission: String, deviceId: Int)
Gets whether you should show UI with rationale before requesting a permission.
|
Boolean |
shouldUpRecreateTask(targetIntent: Intent!)
Returns true if the app should recreate the task when navigating 'up' from this activity by using targetIntent.
If this method returns false the app can trivially call navigateUpTo(android.content.Intent) using the same parameters to correctly perform up navigation. If this method returns false, the app should synthesize a new task stack by using TaskStackBuilder or another similar mechanism to perform up navigation.
|
Boolean |
showAssist(args: Bundle!)
Ask to have the current assistant shown to the user. This only works if the calling activity is the current foreground activity. It is the same as calling VoiceInteractionService.showSession and requesting all of the possible context. The receiver will always see android.service.voice.VoiceInteractionSession#SHOW_SOURCE_APPLICATION set.
|
Unit |
showDialog(id: Int)
Simple version of showDialog(int,android.os.Bundle) that does not take any arguments. Simply calls showDialog(int,android.os.Bundle) with null arguments.
|
Boolean |
showDialog(id: Int, args: Bundle!)
Show a dialog managed by this activity. A call to onCreateDialog(int,android.os.Bundle) will be made with the same id the first time this is called for a given id. From thereafter, the dialog will be automatically saved and restored. If you are targeting android.os.Build.VERSION_CODES#HONEYCOMB or later, consider instead using a DialogFragment instead.
Each time a dialog is shown, onPrepareDialog(int,android.app.Dialog,android.os.Bundle) will be made to provide an opportunity to do any timely preparation.
|
Unit |
showLockTaskEscapeMessage()
Shows the user the system defined message for telling the user how to exit lock task mode. The task containing this activity must be in lock task mode at the time of this call for the message to be displayed.
|
ActionMode? |
startActionMode(callback: ActionMode.Callback!)
Start an action mode of the default type ActionMode#TYPE_PRIMARY.
|
ActionMode? |
startActionMode(callback: ActionMode.Callback!, type: Int)
Start an action mode of the given type.
|
Unit |
startActivities(intents: Array<Intent!>!)
Same as #startActivities(android.content.Intent[],android.os.Bundle) with no options specified.
|
Unit |
startActivities(intents: Array<Intent!>!, options: Bundle?)
Launch a new activity. You will not receive any information about when the activity exits. This implementation overrides the base version, providing information about the activity performing the launch. Because of this additional information, the Intent#FLAG_ACTIVITY_NEW_TASK launch flag is not required; if not specified, the new activity will be added to the task of the caller.
This method throws android.content.ActivityNotFoundException if there was no Activity found to run the given Intent.
|
Unit |
startActivity(intent: Intent!)
Same as #startActivity(android.content.Intent,android.os.Bundle) with no options specified.
|
Unit |
startActivity(intent: Intent!, options: Bundle?)
Launch a new activity. You will not receive any information about when the activity exits. This implementation overrides the base version, providing information about the activity performing the launch. Because of this additional information, the Intent#FLAG_ACTIVITY_NEW_TASK launch flag is not required; if not specified, the new activity will be added to the task of the caller.
This method throws android.content.ActivityNotFoundException if there was no Activity found to run the given Intent.
|
Unit |
startActivityForResult(intent: Intent!, requestCode: Int)
Same as calling startActivityForResult(android.content.Intent,int,android.os.Bundle) with no options.
|
Unit |
startActivityForResult(intent: Intent!, requestCode: Int, options: Bundle?)
Launch an activity for which you would like a result when it finished. When this activity exits, your onActivityResult() method will be called with the given requestCode. Using a negative requestCode is the same as calling #startActivity (the activity is not launched as a sub-activity).
Note that this method should only be used with Intent protocols that are defined to return a result. In other protocols (such as Intent#ACTION_MAIN or Intent#ACTION_VIEW), you may not get the result when you expect. For example, if the activity you are launching uses Intent#FLAG_ACTIVITY_NEW_TASK, it will not run in your task and thus you will immediately receive a cancel result.
As a special case, if you call startActivityForResult() with a requestCode >= 0 during the initial onCreate(Bundle savedInstanceState)/onResume() of your activity, then your window will not be displayed until a result is returned back from the started activity. This is to avoid visible flickering when redirecting to another activity.
This method throws android.content.ActivityNotFoundException if there was no Activity found to run the given Intent.
|
Unit |
startActivityFromChild(child: Activity, intent: Intent!, requestCode: Int)
Same as calling startActivityFromChild(android.app.Activity,android.content.Intent,int,android.os.Bundle) with no options.
|
Unit |
startActivityFromChild(child: Activity, intent: Intent!, requestCode: Int, options: Bundle?)
This is called when a child activity of this one calls its #startActivity or #startActivityForResult method.
This method throws android.content.ActivityNotFoundException if there was no Activity found to run the given Intent.
|
Unit |
startActivityFromFragment(fragment: Fragment, intent: Intent!, requestCode: Int)
Same as calling startActivityFromFragment(android.app.Fragment,android.content.Intent,int,android.os.Bundle) with no options.
|
Unit |
startActivityFromFragment(fragment: Fragment, intent: Intent!, requestCode: Int, options: Bundle?)
This is called when a Fragment in this activity calls its android.app.Fragment#startActivity or android.app.Fragment#startActivityForResult method.
This method throws android.content.ActivityNotFoundException if there was no Activity found to run the given Intent.
|
Boolean |
startActivityIfNeeded(intent: Intent, requestCode: Int)
Same as calling startActivityIfNeeded(android.content.Intent,int,android.os.Bundle) with no options.
|
Boolean |
startActivityIfNeeded(intent: Intent, requestCode: Int, options: Bundle?)
A special variation to launch an activity only if a new activity instance is needed to handle the given Intent. In other words, this is just like startActivityForResult(android.content.Intent,int) except: if you are using the Intent#FLAG_ACTIVITY_SINGLE_TOP flag, or singleTask or singleTop launchMode, and the activity that handles intent is the same as your currently running activity, then a new instance is not needed. In this case, instead of the normal behavior of calling #onNewIntent this function will return and you can handle the Intent yourself.
This function can only be called from a top-level activity; if it is called from a child activity, a runtime exception will be thrown.
|
Unit |
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int)
Same as calling #startIntentSender(android.content.IntentSender,android.content.Intent,int,int,int,android.os.Bundle) with no options.
|
Unit |
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?)
Like #startActivity(android.content.Intent,android.os.Bundle), but taking a IntentSender to start; see startIntentSenderForResult(android.content.IntentSender,int,android.content.Intent,int,int,int,android.os.Bundle) for more information.
|
Unit |
startIntentSenderForResult(intent: IntentSender!, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int)
Same as calling startIntentSenderForResult(android.content.IntentSender,int,android.content.Intent,int,int,int,android.os.Bundle) with no options.
|
Unit |
startIntentSenderForResult(intent: IntentSender!, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?)
Like startActivityForResult(android.content.Intent,int), but allowing you to use a IntentSender to describe the activity to be started. If the IntentSender is for an activity, that activity will be started as if you had called the regular startActivityForResult(android.content.Intent,int) here; otherwise, its associated action will be executed (such as sending a broadcast) as if you had called android.content.IntentSender#sendIntent on it.
|
Unit |
startIntentSenderFromChild(child: Activity!, intent: IntentSender!, requestCode: Int, fillInIntent: Intent!, flagsMask: Int, flagsValues: Int, extraFlags: Int)
Same as calling startIntentSenderFromChild(android.app.Activity,android.content.IntentSender,int,android.content.Intent,int,int,int,android.os.Bundle) with no options.
|
Unit |
startIntentSenderFromChild(child: Activity!, intent: IntentSender!, requestCode: Int, fillInIntent: Intent!, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?)
Like startActivityFromChild(android.app.Activity,android.content.Intent,int), but taking a IntentSender; see startIntentSenderForResult(android.content.IntentSender,int,android.content.Intent,int,int,int) for more information.
|
Unit |
startLocalVoiceInteraction(privateOptions: Bundle!)
Starts a local voice interaction session. When ready, onLocalVoiceInteractionStarted() is called. You can pass a bundle of private options to the registered voice interaction service.
|
Unit |
startLockTask()
Request to put this activity in a mode where the user is locked to a restricted set of applications.
If DevicePolicyManager#isLockTaskPermitted(String) returns true for this component, the current task will be launched directly into LockTask mode. Only apps allowlisted by DevicePolicyManager#setLockTaskPackages(ComponentName, String[]) can be launched while LockTask mode is active. The user will not be able to leave this mode until this activity calls stopLockTask(). Calling this method while the device is already in LockTask mode has no effect.
Otherwise, the current task will be launched into screen pinning mode. In this case, the system will prompt the user with a dialog requesting permission to use this mode. The user can exit at any time through instructions shown on the request dialog. Calling stopLockTask() will also terminate this mode.
Note: this method can only be called when the activity is foreground. That is, between onResume() and onPause().
|
Unit |
startManagingCursor(c: Cursor!)
This method allows the activity to take care of managing the given Cursor's lifecycle for you based on the activity's lifecycle. That is, when the activity is stopped it will automatically call Cursor#deactivate on the given Cursor, and when it is later restarted it will call Cursor#requery for you. When the activity is destroyed, all managed Cursors will be closed automatically. If you are targeting android.os.Build.VERSION_CODES#HONEYCOMB or later, consider instead using LoaderManager instead, available via getLoaderManager().
Warning: Do not call android.database.Cursor#close() on cursor obtained from managedQuery, because the activity will do that for you at the appropriate time. However, if you call stopManagingCursor on a cursor from a managed query, the system will not automatically close the cursor and, in that case, you must call android.database.Cursor#close().
|
Boolean |
startNextMatchingActivity(intent: Intent)
Same as calling startNextMatchingActivity(android.content.Intent,android.os.Bundle) with no options.
|
Boolean |
startNextMatchingActivity(intent: Intent, options: Bundle?)
Special version of starting an activity, for use when you are replacing other activity components. You can use this to hand the Intent off to the next Activity that can handle it. You typically call this in #onCreate with the Intent returned by getIntent.
|
Unit |
startPostponedEnterTransition()
Begin postponed transitions after postponeEnterTransition() was called. If postponeEnterTransition() was called, you must call startPostponedEnterTransition() to have your Activity start drawing.
|
Unit |
startSearch(initialQuery: String?, selectInitialQuery: Boolean, appSearchData: Bundle?, globalSearch: Boolean)
This hook is called to launch the search UI.
It is typically called from onSearchRequested(), either directly from Activity.onSearchRequested() or from an overridden version in any given Activity. If your goal is simply to activate search, it is preferred to call onSearchRequested(), which may have been overridden elsewhere in your Activity. If your goal is to inject specific data such as context data, it is preferred to override onSearchRequested(), so that any callers to it will benefit from the override.
Note: when running in a Configuration#UI_MODE_TYPE_WATCH, use of this API is not supported.
|
Unit |
stopLocalVoiceInteraction()
Request to terminate the current voice interaction that was previously started using startLocalVoiceInteraction(android.os.Bundle). When the interaction is terminated, onLocalVoiceInteractionStopped() will be called.
|
Unit |
stopLockTask()
Stop the current task from being locked.
Called to end the LockTask or screen pinning mode started by startLockTask(). This can only be called by activities that have called startLockTask() previously.
Note: If the device is in LockTask mode that is not initially started by this activity, then calling this method will not terminate the LockTask mode, but only finish its own task. The device will remain in LockTask mode, until the activity which started the LockTask mode calls this method, or until its allowlist authorization is revoked by DevicePolicyManager#setLockTaskPackages(ComponentName, String[]).
|
Unit |
stopManagingCursor(c: Cursor!)
Given a Cursor that was previously given to startManagingCursor, stop the activity's management of that cursor.
Warning: After calling this method on a cursor from a managed query, the system will not automatically close the cursor and you must call android.database.Cursor#close().
|
Unit |
takeKeyEvents(get: Boolean)
Request that key events come to this activity. Use this if your activity has no views with focus, but the activity still wants a chance to process key events.
|
Unit |
triggerSearch(query: String!, appSearchData: Bundle?)
Similar to startSearch, but actually fires off the search query after invoking the search dialog. Made available for testing purposes.
|
Unit |
unregisterActivityLifecycleCallbacks(callback: Application.ActivityLifecycleCallbacks)
Unregister an Application.ActivityLifecycleCallbacks previously registered with registerActivityLifecycleCallbacks. It will not receive any further callbacks.
|
Unit |
unregisterComponentCallbacks(callback: ComponentCallbacks!)
|
Unit |
unregisterForContextMenu(view: View!)
Prevents a context menu to be shown for the given view. This method will remove the OnCreateContextMenuListener on the view.
|
Unit |
unregisterScreenCaptureCallback(callback: Activity.ScreenCaptureCallback)
Unregisters a screen capture callback for this surface.
Requires android.Manifest.permission#DETECT_SCREEN_CAPTURE
|
