added in version 22.1.0
belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1
Summary: Nested Classes | Protected Ctors | Methods | Inherited Methods | [Expand All]

ActivityCompat

public class ActivityCompat
extends ContextCompat

java.lang.Object
   ↳ android.support.v4.content.ContextCompat
     ↳ android.support.v4.app.ActivityCompat
Known Direct Subclasses

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 was deprecated in API level 27.1.0. Use invalidateOptionsMenu() directly.

static void postponeEnterTransition(Activity activity)
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 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 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 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 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 for 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 android.support.v4.content.ContextCompat
From class java.lang.Object

Protected constructors

ActivityCompat

added in version 22.1.0
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

added in version 22.1.0
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 finish() will be called instead.

Parameters
activity Activity

finishAfterTransition

added in version 22.1.0
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, 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

added in version 24.1.0
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 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

added in version 22.1.0
boolean invalidateOptionsMenu (Activity activity)

This method was deprecated in API level 27.1.0.
Use 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 onCreateOptionsMenu(android.view.Menu) and onPrepareOptionsMenu(android.view.Menu) respectively. Subsequent presses of the menu key kept the existing instance of the Menu itself and called 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 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 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

added in version 22.1.0
void postponeEnterTransition (Activity activity)

Parameters
activity Activity

requestDragAndDropPermissions

added in version 24.1.0
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

added in version 24.1.0
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 #PROTECTION_DANGEROUS dangerous, regardless whether they are declared by the platform or a third-party app.

Normal permissions PROTECTION_NORMAL are granted at install time if requested in the manifest. Signature permissions 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.

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

When checking whether you have a permission you should use 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 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 be non-null and not empty.
requestCode int: Application specific request code to match with a result reported to onRequestPermissionsResult(int, String[], int[]). Should be >= 0.

requireViewById

added in version 27.1.0
T requireViewById (Activity activity,
                int id)

Finds a view that was identified by the android:id XML attribute that was processed in 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

setEnterSharedElementCallback

added in version 22.1.0
void setEnterSharedElementCallback (Activity activity,
                SharedElementCallback callback)

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

Parameters
activity Activity

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

setExitSharedElementCallback

added in version 22.1.0
void setExitSharedElementCallback (Activity activity,
                SharedElementCallback callback)

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

Parameters
activity Activity

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

setPermissionCompatDelegate

added in version 27.1.0
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

added in version 24.1.0
boolean shouldShowRequestPermissionRationale (Activity activity,
                String permission)

Gets whether you should show UI with rationale for requesting a permission. You should do this only if you do not have the permission and the context in which the permission is requested does not clearly communicate to the user what would be the benefit from granting this permission.

For example, if you write a camera app, requesting the camera permission would be expected by the user and no rationale for why it is requested is needed. If however, the app needs location for tagging photos then a non-tech savvy user may wonder how location is related to taking photos. In this case you may choose to show UI with rationale of requesting this permission.

Parameters
activity Activity: The target activity.
permission String: A permission your app wants to request.
Returns
boolean Whether you can show permission rationale UI.

startActivityForResult

added in version 22.1.0
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

added in version 24.1.0
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.

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

added in version 22.1.0
void startPostponedEnterTransition (Activity activity)

Parameters
activity Activity