Summary: Nested Classes | Protected Ctors | Methods | Inherited Methods

ActivityCompat

Kotlin |Java

public class ActivityCompat
extends ContextCompat

java.lang.Object
↳	androidx.core.content.ContextCompat
	↳	androidx.core.app.ActivityCompat

Helper for accessing features in Activity.

Summary

Nested classes
`interface`	`ActivityCompat.OnRequestPermissionsResultCallback` This interface is the contract for receiving the results for permission requests.
`interface`	`ActivityCompat.PermissionCompatDelegate` Customizable delegate that allows delegating permission compatibility methods to a custom implementation.

Protected constructors
`ActivityCompat()` This class should not be instantiated, but the constructor must be visible for the class to be extended (as in support-v13).

Public methods
`static void`	`finishAffinity(Activity activity)` Finish this activity, and tries to finish all activities immediately below it in the current task that have the same affinity.
`static void`	`finishAfterTransition(Activity activity)` Reverses the Activity Scene entry Transition and triggers the calling Activity to reverse its exit Transition.
`static Uri`	`getReferrer(Activity activity)` Return information about who launched this activity.
`static boolean`	`invalidateOptionsMenu(Activity activity)` This method is deprecated. Use `Activity.invalidateOptionsMenu()` directly.
`static void`	`postponeEnterTransition(Activity activity)`
`static void`	`recreate(Activity activity)` Cause the given Activity to be recreated with a new instance.
`static DragAndDropPermissionsCompat`	`requestDragAndDropPermissions(Activity activity, DragEvent dragEvent)` Create `DragAndDropPermissionsCompat` object bound to this activity and controlling the access permissions for content URIs associated with the `DragEvent`.
`static void`	`requestPermissions(Activity activity, String[] permissions, int requestCode)` Requests permissions to be granted to this application.
`static <T extends View> T`	`requireViewById(Activity activity, int id)` Finds a view that was identified by the `android:id` XML attribute that was processed in `Activity.onCreate(Bundle)`, or throws an IllegalArgumentException if the ID is invalid, or there is no matching view in the hierarchy.
`static void`	`setEnterSharedElementCallback(Activity activity, SharedElementCallback callback)` When `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.
`static void`	`setExitSharedElementCallback(Activity activity, SharedElementCallback callback)` When `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.
`static void`	`setLocusContext(Activity activity, LocusIdCompat locusId, Bundle bundle)` Sets the `LocusIdCompat` for this activity.
`static void`	`setPermissionCompatDelegate(ActivityCompat.PermissionCompatDelegate delegate)` Sets the permission delegate for `ActivityCompat`.
`static boolean`	`shouldShowRequestPermissionRationale(Activity activity, String permission)` Gets whether you should show UI with rationale before requesting a permission.
`static void`	`startActivityForResult(Activity activity, Intent intent, int requestCode, Bundle options)` Start new activity with options, if able, for which you would like a result when it finished.
`static void`	`startIntentSenderForResult(Activity activity, IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Start new IntentSender with options, if able, for which you would like a result when it finished.
`static void`	`startPostponedEnterTransition(Activity activity)`

Inherited methods

From class


        
          androidx.core.content.ContextCompat

`static int`	`checkSelfPermission(Context context, String permission)` Determine whether you have been granted a particular permission.
`static Context`	`createDeviceProtectedStorageContext(Context context)` Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.
`static File`	`getCodeCacheDir(Context context)` Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
`static int`	`getColor(Context context, int id)` Returns a color associated with a particular resource ID Starting in `Build.VERSION_CODES.M`, the returned color will be styled for the specified Context's theme.
`static ColorStateList`	`getColorStateList(Context context, int id)` Returns a color state list associated with a particular resource ID.
`static File`	`getDataDir(Context context)` Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.
`static Drawable`	`getDrawable(Context context, int id)` Returns a drawable object associated with a particular resource ID.
`static File[]`	`getExternalCacheDirs(Context context)` Returns absolute paths to application-specific directories on all external storage devices where the application can place cache files it owns.
`static File[]`	`getExternalFilesDirs(Context context, String type)` Returns absolute paths to application-specific directories on all external storage devices where the application can place persistent files it owns.
`static Executor`	`getMainExecutor(Context context)` Return an `Executor` that will run enqueued tasks on the main thread associated with this context.
`static File`	`getNoBackupFilesDir(Context context)` Returns the absolute path to the directory on the filesystem similar to `Context.getFilesDir()`.
`static File[]`	`getObbDirs(Context context)` Returns absolute paths to application-specific directories on all external storage devices where the application's OBB files (if there are any) can be found.
`static <T> T`	`getSystemService(Context context, Class<T> serviceClass)` Return the handle to a system-level service by class.
`static String`	`getSystemServiceName(Context context, Class<?> serviceClass)` Gets the name of the system-level service that is represented by the specified class.
`static boolean`	`isDeviceProtectedStorage(Context context)` Indicates if the storage APIs of this Context are backed by device-encrypted storage.
`static boolean`	`startActivities(Context context, Intent[] intents, Bundle options)` Start a set of activities as a synthesized task stack, if able.
`static boolean`	`startActivities(Context context, Intent[] intents)` Start a set of activities as a synthesized task stack, if able.
`static void`	`startActivity(Context context, Intent intent, Bundle options)` Start an activity with additional launch information, if able.
`static void`	`startForegroundService(Context context, Intent intent)` startForegroundService() was introduced in O, just call startService for before O.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Protected constructors

ActivityCompat

protected ActivityCompat ()

This class should not be instantiated, but the constructor must be visible for the class to be extended (as in support-v13).

Public methods

finishAffinity

public static void finishAffinity (Activity activity)

Finish this activity, and tries to finish all activities immediately below it in the current task that have the same affinity.

On Android 4.1+ calling this method will call through to the native version of this method. For other platforms Activity.finish() will be called instead.

Parameters
`activity`	`Activity`

finishAfterTransition

public static void finishAfterTransition (Activity activity)

Reverses the Activity Scene entry Transition and triggers the calling Activity to reverse its exit Transition. When the exit Transition completes, Activity.finish() is called. If no entry Transition was used, finish() is called immediately and the Activity exit Transition is run.

On Android 4.4 or lower, this method only finishes the Activity with no special exit transition.

Parameters
`activity`	`Activity`

getReferrer

public static Uri getReferrer (Activity activity)

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 Activity.onNewIntent(Intent), this function will return the referrer that submitted that new intent to the activity. Otherwise, it always returns the referrer of the original Intent.

Note that this is not a security feature -- you can not trust the referrer information, applications can spoof it.

Parameters
`activity`	`Activity`

Returns
`Uri`

invalidateOptionsMenu

public static boolean invalidateOptionsMenu (Activity activity)

This method is deprecated.
Use Activity.invalidateOptionsMenu() directly.

Invalidate the activity's options menu, if able.

Before API level 11 (Android 3.0/Honeycomb) the lifecycle of the options menu was controlled primarily by the user's operation of the hardware menu key. When the user presses down on the menu key for the first time the menu was created and prepared by calls to Activity.onCreateOptionsMenu(android.view.Menu) and Activity.onPrepareOptionsMenu(android.view.Menu) respectively. Subsequent presses of the menu key kept the existing instance of the Menu itself and called Activity.onPrepareOptionsMenu(android.view.Menu) to give the activity an opportunity to contextually alter the menu before the menu panel was shown.

In Android 3.0+ the Action Bar forces the options menu to be built early so that items chosen to show as actions may be displayed when the activity first becomes visible. The Activity method invalidateOptionsMenu forces the entire menu to be destroyed and recreated from Activity.onCreateOptionsMenu(android.view.Menu), offering a similar though heavier-weight opportunity to change the menu's contents. Normally this functionality is used to support a changing configuration of Fragments.

Applications may use this support helper to signal a significant change in activity state that should cause the options menu to be rebuilt. If the app is running on an older platform version that does not support menu invalidation the app will still receive Activity.onPrepareOptionsMenu(android.view.Menu) the next time the user presses the menu key and this method will return false. If this method returns true the options menu was successfully invalidated.

Parameters
`activity`	`Activity`: Invalidate the options menu of this activity

Returns
`boolean`	true if this operation was supported and it completed; false if it was not available.

postponeEnterTransition

public static void postponeEnterTransition (Activity activity)

Parameters
`activity`	`Activity`

recreate

public static void recreate (Activity activity)

Cause the given Activity to be recreated with a new instance. This version of the method allows a consistent behavior across API levels, emulating what happens on Android Pie (and newer) when running on older platforms.

Parameters
`activity`	`Activity`: The activity to recreate

requestDragAndDropPermissions

public static DragAndDropPermissionsCompat requestDragAndDropPermissions (Activity activity, 
                DragEvent dragEvent)

Create DragAndDropPermissionsCompat object bound to this activity and controlling the access permissions for content URIs associated with the DragEvent.

Parameters
`activity`	`Activity`
`dragEvent`	`DragEvent`: Drag event to request permission for

Returns
`DragAndDropPermissionsCompat`	The `DragAndDropPermissionsCompat` object used to control access to the content URIs. `null` if no content URIs are associated with the event or if permissions could not be granted.

requestPermissions

public static void requestPermissions (Activity activity, 
                String[] permissions, 
                int requestCode)

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 PermissionInfo.PROTECTION_NORMAL are granted at install time if requested in the manifest. Signature permissions 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(Activity, String) before calling this API to check if the system recommends to show a rationale dialog 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 reporting whether the permissions were granted or not. Your activity has to implement ActivityCompat.OnRequestPermissionsResultCallback and the results of permission requests will be delivered to its ActivityCompat.OnRequestPermissionsResultCallback.onRequestPermissionsResult(int, String[], int[]) method.

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 your ActivityCompat.OnRequestPermissionsResultCallback.onRequestPermissionsResult(int, String[], int[]).

When checking whether you have a permission you should use ContextCompat.checkSelfPermission(android.content.Context, String).

Calling this API for permissions already granted to your app would show UI to the user to decided whether the app can still hold these permissions. This can be useful if the way your app uses the data guarded by the permissions changes significantly.

You cannot request a permission if your activity sets noHistory to true in the manifest because in this case the activity would not receive result callbacks including ActivityCompat.OnRequestPermissionsResultCallback.onRequestPermissionsResult(int, String[], int[]).

The RuntimePermissions sample app demonstrates how to use this method to request permissions at run time.

Parameters
`activity`	`Activity`: The target activity.
`permissions`	`String`: The requested permissions. Must me non-null and not empty.
`requestCode`	`int`: Application specific request code to match with a result reported to `ActivityCompat.OnRequestPermissionsResultCallback.onRequestPermissionsResult(int, String[], int[])`. Should be >= 0.

See also:

requireViewById

public static T requireViewById (Activity activity, 
                int id)

Finds a view that was identified by the android:id XML attribute that was processed in Activity.onCreate(Bundle), 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.

Parameters
`activity`	`Activity`
`id`	`int`: the ID to search for

Returns
`T`	a view with given ID

See also:

setEnterSharedElementCallback

public static void setEnterSharedElementCallback (Activity activity, 
                SharedElementCallback callback)

When 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_CONTENT_TRANSITIONS.

Parameters
`activity`	`Activity`
`callback`	`SharedElementCallback`: Used to manipulate shared element transitions on the launched Activity.

setExitSharedElementCallback

public static void setExitSharedElementCallback (Activity activity, 
                SharedElementCallback callback)

When 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_CONTENT_TRANSITIONS.

Parameters
`activity`	`Activity`
`callback`	`SharedElementCallback`: Used to manipulate shared element transitions on the launching Activity.

setLocusContext

public static void setLocusContext (Activity activity, 
                LocusIdCompat locusId, 
                Bundle bundle)

Sets the LocusIdCompat 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 ShortcutInfoCompat.Builder.setLocusId(LocusIdCompat) so that the system can learn appropriate ranking signals linking the activity's locus id with the matching shortcut.

Parameters
`activity`	`Activity`
`locusId`	`LocusIdCompat`: a unique, stable id that identifies this `Activity` instance. LocusId is an opaque ID that links this Activity's state to different Android concepts: `ShortcutInfoCompat.Builder.setLocusId(LocusIdCompat)`. LocusID is null by default or if you explicitly reset it.
`bundle`	`Bundle`: extras set or updated as part of this locus context. This may help provide additional metadata such as URLs, conversation participants specific to this `Activity`'s context. Bundle can be null if additional metadata is not needed. Bundle should always be null for null locusId.

See also:

setPermissionCompatDelegate

public static void setPermissionCompatDelegate (ActivityCompat.PermissionCompatDelegate delegate)

Sets the permission delegate for ActivityCompat. Replaces the previously set delegate.

Parameters
`delegate`	`ActivityCompat.PermissionCompatDelegate`: The delegate to be set. `null` to clear the set delegate.

shouldShowRequestPermissionRationale

public static boolean shouldShowRequestPermissionRationale (Activity activity, 
                String permission)

Gets whether you should show UI with rationale before requesting a permission.

Parameters
`activity`	`Activity`: The target activity.
`permission`	`String`: A permission your app wants to request.

Returns
`boolean`	Whether you should show permission rationale UI.

See also:

startActivityForResult

public static void startActivityForResult (Activity activity, 
                Intent intent, 
                int requestCode, 
                Bundle options)

Start new activity with options, if able, for which you would like a result when it finished.

In Android 4.1+ additional options were introduced to allow for more control on activity launch animations. Applications can use this method along with ActivityOptionsCompat to use these animations when available. When run on versions of the platform where this feature does not exist the activity will be launched normally.

Parameters
`activity`	`Activity`: Origin activity to launch from.
`intent`	`Intent`: The description of the activity to start.
`requestCode`	`int`: If >= 0, this code will be returned in onActivityResult() when the activity exits.
`options`	`Bundle`: Additional options for how the Activity should be started. May be null if there are no options. See `ActivityOptionsCompat` for how to build the Bundle supplied here; there are no supported definitions for building it manually.

startIntentSenderForResult

public static void startIntentSenderForResult (Activity activity, 
                IntentSender intent, 
                int requestCode, 
                Intent fillInIntent, 
                int flagsMask, 
                int flagsValues, 
                int extraFlags, 
                Bundle options)

Start new IntentSender with options, if able, for which you would like a result when it finished.

Parameters
`activity`	`Activity`: Origin activity to launch from.
`intent`	`IntentSender`: The IntentSender to launch.
`requestCode`	`int`: If >= 0, this code will be returned in onActivityResult() when the activity exits.
`fillInIntent`	`Intent`: If non-null, this will be provided as the intent parameter to `IntentSender.sendIntent(Context, int, Intent, IntentSender.OnFinished, Handler)`.
`flagsMask`	`int`: Intent flags in the original IntentSender that you would like to change.
`flagsValues`	`int`: Desired values for any bits set in `flagsMask`
`extraFlags`	`int`: Always set to 0.
`options`	`Bundle`: Additional options for how the Activity should be started. May be null if there are no options. See `ActivityOptionsCompat` for how to build the Bundle supplied here; there are no supported definitions for building it manually.

Throws
`IntentSender.SendIntentException`

startPostponedEnterTransition

public static void startPostponedEnterTransition (Activity activity)

Parameters
`activity`	`Activity`

ActivityCompat

Summary

Nested classes

Protected constructors

Public methods

Inherited methods

Protected constructors

ActivityCompat

Public methods

finishAffinity

finishAfterTransition

getReferrer

invalidateOptionsMenu

postponeEnterTransition

recreate

requestDragAndDropPermissions

requestPermissions

requireViewById

setEnterSharedElementCallback

setExitSharedElementCallback

setLocusContext

setPermissionCompatDelegate

shouldShowRequestPermissionRationale

startActivityForResult

startIntentSenderForResult

startPostponedEnterTransition