ActivityOptions

EXTRA_USAGE_TIME_REPORT

public static final String EXTRA_USAGE_TIME_REPORT

A long in the extras delivered by requestUsageTimeReport(PendingIntent) that contains the total time (in ms) the user spent in the app flow.

Constant Value: "android.activity.usage_time"

EXTRA_USAGE_TIME_REPORT_PACKAGES

public static final String EXTRA_USAGE_TIME_REPORT_PACKAGES

A Bundle in the extras delivered by requestUsageTimeReport(PendingIntent) that contains detailed information about the time spent in each package associated with the app; each key is a package name, whose value is a long containing the time (in ms).

Constant Value: "android.usage_time_packages"

MODE_BACKGROUND_ACTIVITY_START_ALLOWED

public static final int MODE_BACKGROUND_ACTIVITY_START_ALLOWED

This constant was deprecated in API level Baklava.
Use MODE_BACKGROUND_ACTIVITY_START_ALLOW_IF_VISIBLE to allow starts only when the app is visible or MODE_BACKGROUND_ACTIVITY_START_ALLOW_ALWAYS to allow starts at any time (see Restrictions on starting activities from the background).

Grants the PendingIntent background activity start privileges. This behaves the same as MODE_BACKGROUND_ACTIVITY_START_ALLOW_ALWAYS, except it does not grant background activity launch permissions based on the privileged permission START_ACTIVITIES_FROM_BACKGROUND.

Constant Value: 1 (0x00000001)

MODE_BACKGROUND_ACTIVITY_START_ALLOW_ALWAYS

public static final int MODE_BACKGROUND_ACTIVITY_START_ALLOW_ALWAYS

Grants the PendingIntent all background activity start privileges, including those normally reserved for privileged contexts (e.g., companion apps or those with the START_ACTIVITIES_FROM_BACKGROUND permission).

Caution: This mode should be used sparingly. Most apps should use MODE_BACKGROUND_ACTIVITY_START_ALLOW_IF_VISIBLE instead, relying on notifications or foreground services for background interactions to minimize user disruption. However, this mode is necessary for specific use cases, such as companion apps responding to prompts from a connected device.

For more information on background activity start restrictions, see: Restrictions on starting activities from the background

Constant Value: 3 (0x00000003)

MODE_BACKGROUND_ACTIVITY_START_ALLOW_IF_VISIBLE

public static final int MODE_BACKGROUND_ACTIVITY_START_ALLOW_IF_VISIBLE

Grants the PendingIntent background activity start privileges only when the app has a visible window (i.e., is visible to the user). This is the recommended mode for most apps to minimize disruption to the user experience.

For more information on background activity start restrictions, see: Restrictions on starting activities from the background

Constant Value: 4 (0x00000004)

MODE_BACKGROUND_ACTIVITY_START_DENIED

public static final int MODE_BACKGROUND_ACTIVITY_START_DENIED

Denies the PendingIntent any background activity start privileges.

Constant Value: 2 (0x00000002)

MODE_BACKGROUND_ACTIVITY_START_SYSTEM_DEFINED

public static final int MODE_BACKGROUND_ACTIVITY_START_SYSTEM_DEFINED

The system determines whether to grant background activity start privileges. This is the default behavior if no explicit mode is specified.

Constant Value: 0 (0x00000000)

getLaunchBounds

public Rect getLaunchBounds ()

Returns the bounds that should be used to launch the activity.

getLaunchDisplayId

public int getLaunchDisplayId ()

Gets the id of the display where activity should be launched.

getLockTaskMode

public boolean getLockTaskMode ()

Gets whether the activity is to be launched into LockTask mode.

getPendingIntentBackgroundActivityStartMode

public int getPendingIntentBackgroundActivityStartMode ()

Get the mode for allowing or denying the senders privileges to start background activities to the PendingIntent.

getPendingIntentCreatorBackgroundActivityStartMode

public int getPendingIntentCreatorBackgroundActivityStartMode ()

Returns the mode to start background activities granted by the creator of the PendingIntent.

getSplashScreenStyle

public int getSplashScreenStyle ()

Gets the style can be used for cold-launching an activity.

isAllowPassThroughOnTouchOutside

public boolean isAllowPassThroughOnTouchOutside ()

Returns whether the source activity allows the overlaying activities from the to-be-launched app to pass through touch events to it when touches fall outside the content window.

isPendingIntentBackgroundActivityLaunchAllowed

public boolean isPendingIntentBackgroundActivityLaunchAllowed ()

This method was deprecated in API level 34.
use getPendingIntentBackgroundActivityStartMode() since for apps targeting Build.VERSION_CODES.UPSIDE_DOWN_CAKE or higher this value might not match the actual behavior if the value was not explicitly set.

Get PendingIntent activity is allowed to be started in the background if the caller can start background activities.

isShareIdentityEnabled

public boolean isShareIdentityEnabled ()

Returns whether the launching app has opted-in to sharing its identity with the launched activity.

makeBasic

public static ActivityOptions makeBasic ()

Create a basic ActivityOptions that has no special animation associated with it. Other options can still be set.

makeClipRevealAnimation

public static ActivityOptions makeClipRevealAnimation (View source, 
                int startX, 
                int startY, 
                int width, 
                int height)

Create an ActivityOptions specifying an animation where the new activity is revealed from a small originating area of the screen to its final full representation.

makeCustomAnimation

public static ActivityOptions makeCustomAnimation (Context context, 
                int enterResId, 
                int exitResId)

Create an ActivityOptions specifying a custom animation to run when the activity is displayed.

makeCustomAnimation

public static ActivityOptions makeCustomAnimation (Context context, 
                int enterResId, 
                int exitResId, 
                int backgroundColor)

Create an ActivityOptions specifying a custom animation to run when the activity is displayed.

makeLaunchIntoPip

public static ActivityOptions makeLaunchIntoPip (PictureInPictureParams pictureInPictureParams)

Creates an ActivityOptions instance that launch into picture-in-picture. This is normally used by a Host activity to start another activity that will directly enter picture-in-picture upon its creation.

makeScaleUpAnimation

public static ActivityOptions makeScaleUpAnimation (View source, 
                int startX, 
                int startY, 
                int width, 
                int height)

Create an ActivityOptions specifying an animation where the new activity is scaled from a small originating area of the screen to its final full representation.

If the Intent this is being used with has not set its Intent.setSourceBounds, those bounds will be filled in for you based on the initial bounds passed in here.

makeSceneTransitionAnimation

public static ActivityOptions makeSceneTransitionAnimation (Activity activity, 
                View sharedElement, 
                String sharedElementName)

Create an ActivityOptions to transition between Activities using cross-Activity scene animations. This method carries the position of one shared element to the started Activity. The position of sharedElement will be used as the epicenter for the exit Transition. The position of the shared element in the launched Activity will be the epicenter of its entering Transition.

This requires Window.FEATURE_ACTIVITY_TRANSITIONS to be enabled on the calling Activity to cause an exit transition. The same must be in the called Activity to get an entering transition.

makeSceneTransitionAnimation

public static ActivityOptions makeSceneTransitionAnimation (Activity activity, 
                Pair...<View, String> sharedElements)

Create an ActivityOptions to transition between Activities using cross-Activity scene animations. This method carries the position of multiple shared elements to the started Activity. The position of the first element in sharedElements will be used as the epicenter for the exit Transition. The position of the associated shared element in the launched Activity will be the epicenter of its entering Transition.

This requires Window.FEATURE_ACTIVITY_TRANSITIONS to be enabled on the calling Activity to cause an exit transition. The same must be in the called Activity to get an entering transition.

makeTaskLaunchBehind

public static ActivityOptions makeTaskLaunchBehind ()

If set along with Intent.FLAG_ACTIVITY_NEW_DOCUMENT then the task being launched will not be presented to the user but will instead be only available through the recents task list. In addition, the new task wil be affiliated with the launching activity's task. Affiliated tasks are grouped together in the recents task list.

This behavior is not supported for activities with launchMode values of singleInstance or singleTask.

makeThumbnailScaleUpAnimation

public static ActivityOptions makeThumbnailScaleUpAnimation (View source, 
                Bitmap thumbnail, 
                int startX, 
                int startY)

Create an ActivityOptions specifying an animation where a thumbnail is scaled from a given position to the new activity window that is being started.

If the Intent this is being used with has not set its Intent.setSourceBounds, those bounds will be filled in for you based on the initial thumbnail location and size provided here.

requestUsageTimeReport

public void requestUsageTimeReport (PendingIntent receiver)

Ask the system track that time the user spends in the app being launched, and report it back once done. The report will be sent to the given receiver, with the extras EXTRA_USAGE_TIME_REPORT and EXTRA_USAGE_TIME_REPORT_PACKAGES filled in.

The time interval tracked is from launching this activity until the user leaves that activity's flow. They are considered to stay in the flow as long as new activities are being launched or returned to from the original flow, even if this crosses package or task boundaries. For example, if the originator starts an activity to view an image, and while there the user selects to share, which launches their email app in a new task, and they complete the share, the time during that entire operation will be included until they finally hit back from the original image viewer activity.

The user is considered to complete a flow once they switch to another activity that is not part of the tracked flow. This may happen, for example, by using the notification shade, launcher, or recents to launch or switch to another app. Simply going in to these navigation elements does not break the flow (although the launcher and recents stops time tracking of the session); it is the act of going somewhere else that completes the tracking.

setAllowPassThroughOnTouchOutside

public void setAllowPassThroughOnTouchOutside (boolean allowed)

Sets whether the source activity allows the overlaying activities from the to-be-launched app to pass through touch events to it when touches fall outside the content window.

By default, touches that fall on a translucent non-touchable area of an overlaying activity window are blocked from passing through to the activity below (source activity), unless the overlaying activity is from the same UID as the source activity. The source activity may use this method to opt in and allow the overlaying activities from the to-be-launched app to pass through touches to itself. The source activity needs to ensure that it trusts the overlaying activity and its content is not vulnerable to UI redressing attacks. The flag is ignored if the context calling Context.startActivity(Intent, Bundle) is not an activity.

For backward compatibility, apps with target SDK 35 and below may still receive pass-through touches without opt-in if the cross-uid activity is launched by the source activity.

setAppVerificationBundle

public ActivityOptions setAppVerificationBundle (Bundle bundle)

Set the Bundle that is provided to the app installer for additional verification if the call to Context.startActivity results in an app being installed. This Bundle is not provided to any other app besides the installer.

setLaunchBounds

public ActivityOptions setLaunchBounds (Rect screenSpacePixelRect)

Sets the bounds (window size and position) that the activity should be launched in. Rect position should be provided in pixels and in screen coordinates. Set to null to explicitly launch fullscreen.

NOTE: This value is ignored on devices that don't have PackageManager.FEATURE_FREEFORM_WINDOW_MANAGEMENT or PackageManager.FEATURE_PICTURE_IN_PICTURE enabled.

setLaunchDisplayId

public ActivityOptions setLaunchDisplayId (int launchDisplayId)

Sets the id of the display where the activity should be launched. An app can launch activities on public displays or displays where the app already has activities. Otherwise, trying to launch on a private display or providing an invalid display id will result in an exception.

Setting launch display id will be ignored on devices that don't have PackageManager.FEATURE_ACTIVITIES_ON_SECONDARY_DISPLAYS.

setLockTaskEnabled

public ActivityOptions setLockTaskEnabled (boolean lockTaskMode)

Sets whether the activity is to be launched into LockTask mode. Use this option to start an activity in LockTask mode. Note that only apps permitted by DevicePolicyManager can run in LockTask mode. Therefore, if DevicePolicyManager.isLockTaskPermitted(String) returns false for the package of the target activity, a SecurityException will be thrown during Context.startActivity(Intent, Bundle). This method doesn't affect activities that are already running \u2014 relaunch the activity to run in lock task mode. Defaults to false if not set.

setPendingIntentBackgroundActivityLaunchAllowed

public void setPendingIntentBackgroundActivityLaunchAllowed (boolean allowed)

This method was deprecated in API level 34.
use #setPendingIntentBackgroundActivityStartMode(int) to set the full range of states

Set PendingIntent activity is allowed to be started in the background if the caller can start background activities.

setPendingIntentBackgroundActivityStartMode

public ActivityOptions setPendingIntentBackgroundActivityStartMode (int state)

Sets the mode for allowing or denying the senders privileges to start background activities to the PendingIntent. This is typically used in when executing PendingIntent.send(Context, int, Intent, PendingIntent.OnFinished, Handler, String, Bundle) or similar methods. A privileged sender of a PendingIntent should only grant MODE_BACKGROUND_ACTIVITY_START_ALLOWED if the PendingIntent is from a trusted source and/or executed on behalf the user.

setPendingIntentCreatorBackgroundActivityStartMode

public ActivityOptions setPendingIntentCreatorBackgroundActivityStartMode (int mode)

Allow a PendingIntent to use the privilege of its creator to start background activities.

setShareIdentityEnabled

public ActivityOptions setShareIdentityEnabled (boolean shareIdentity)

Sets whether the identity of the launching app should be shared with the activity.

Use this option when starting an activity that needs to know the identity of the launching app; with this set to true, the activity will have access to the launching app's package name and uid.

Defaults to false if not set.

Note, even if the launching app does not explicitly enable sharing of its identity, if the activity is started with Activity#startActivityForResult, then Activity.getCallingPackage() will still return the launching app's package name to allow validation of the result's recipient. Also, an activity running within a package signed by the same key used to sign the platform (some system apps such as Settings will be signed with the platform's key) will have access to the launching app's identity.

setSplashScreenStyle

public ActivityOptions setSplashScreenStyle (int style)

Sets the preferred splash screen style of the opening activities. This only applies if the Activity or Process is not yet created.

toBundle

public Bundle toBundle ()

Returns the created options as a Bundle, which can be passed to Context.startActivity(Intent, Bundle) and related methods. Note that the returned Bundle is still owned by the ActivityOptions object; you must not modify it, but can supply it to the startActivity methods that take an options Bundle.

update

public void update (ActivityOptions otherOptions)

Update the current values in this ActivityOptions from those supplied in otherOptions. Any values defined in otherOptions replace those in the base options.