Skip to content

Most visited

Recently visited

navigation

ActivityOptions

public class ActivityOptions
extends Object

java.lang.Object
   ↳ android.app.ActivityOptions


Helper class for building an options Bundle that can be used with Context.startActivity(Intent, Bundle) and related methods.

Summary

Constants

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.

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

Public methods

Rect getLaunchBounds()

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

static ActivityOptions makeBasic()

Create a basic ActivityOptions that has no special animation associated with it.

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.

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

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

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.

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

Create an ActivityOptions to transition between Activities using cross-Activity scene animations.

static ActivityOptions makeSceneTransitionAnimation(Activity activity, Pair...<ViewString> sharedElements)

Create an ActivityOptions to transition between Activities using cross-Activity scene animations.

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.

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.

void requestUsageTimeReport(PendingIntent receiver)

Ask the the system track that time the user spends in the app being launched, and report it back once done.

ActivityOptions setLaunchBounds(Rect screenSpacePixelRect)

Sets the bounds (window size) that the activity should be launched in.

Bundle toBundle()

Returns the created options as a Bundle, which can be passed to Context.startActivity(Intent, Bundle) and related methods.

void update(ActivityOptions otherOptions)

Update the current values in this ActivityOptions from those supplied in otherOptions.

Inherited methods

From class java.lang.Object

Constants

EXTRA_USAGE_TIME_REPORT

Added in API level 23
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

Added in API level 23
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"

Public methods

getLaunchBounds

Added in API level 24
Rect getLaunchBounds ()

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

Returns
Rect Bounds used to launch the activity.

See also:

makeBasic

Added in API level 23
ActivityOptions makeBasic ()

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

Returns
ActivityOptions

makeClipRevealAnimation

Added in API level 23
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.

Parameters
source View: The View that the new activity is animating from. This defines the coordinate space for startX and startY.
startX int: The x starting location of the new activity, relative to source.
startY int: The y starting location of the activity, relative to source.
width int: The initial width of the new activity.
height int: The initial height of the new activity.
Returns
ActivityOptions Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

makeCustomAnimation

Added in API level 16
ActivityOptions makeCustomAnimation (Context context, 
                int enterResId, 
                int exitResId)

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

Parameters
context Context: Who is defining this. This is the application that the animation resources will be loaded from.
enterResId int: A resource ID of the animation resource to use for the incoming activity. Use 0 for no animation.
exitResId int: A resource ID of the animation resource to use for the outgoing activity. Use 0 for no animation.
Returns
ActivityOptions Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

makeScaleUpAnimation

Added in API level 16
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.

Parameters
source View: The View that the new activity is animating from. This defines the coordinate space for startX and startY.
startX int: The x starting location of the new activity, relative to source.
startY int: The y starting location of the activity, relative to source.
width int: The initial width of the new activity.
height int: The initial height of the new activity.
Returns
ActivityOptions Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

makeSceneTransitionAnimation

Added in API level 21
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 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.

Parameters
activity Activity: The Activity whose window contains the shared elements.
sharedElement View: The View to transition to the started Activity.
sharedElementName String: The shared element name as used in the target Activity. This must not be null.
Returns
ActivityOptions Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

See also:

makeSceneTransitionAnimation

Added in API level 21
ActivityOptions makeSceneTransitionAnimation (Activity activity, 
                Pair...<ViewString> 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 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.

Parameters
activity Activity: The Activity whose window contains the shared elements.
sharedElements Pair: The names of the shared elements to transfer to the called Activity and their associated Views. The Views must each have a unique shared element name.
Returns
ActivityOptions Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

See also:

makeTaskLaunchBehind

Added in API level 21
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.

Returns
ActivityOptions

makeThumbnailScaleUpAnimation

Added in API level 16
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.

Parameters
source View: The View that this thumbnail is animating from. This defines the coordinate space for startX and startY.
thumbnail Bitmap: The bitmap that will be shown as the initial thumbnail of the animation.
startX int: The x starting location of the bitmap, relative to source.
startY int: The y starting location of the bitmap, relative to source.
Returns
ActivityOptions Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

requestUsageTimeReport

Added in API level 23
void requestUsageTimeReport (PendingIntent receiver)

Ask the 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.

Parameters
receiver PendingIntent: A broadcast receiver that willl receive the report.

setLaunchBounds

Added in API level 24
ActivityOptions setLaunchBounds (Rect screenSpacePixelRect)

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

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

Parameters
screenSpacePixelRect Rect: Launch bounds to use for the activity or null for fullscreen.
Returns
ActivityOptions

toBundle

Added in API level 16
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.

Returns
Bundle

update

Added in API level 16
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.

Parameters
otherOptions ActivityOptions
This site uses cookies to store your preferences for site-specific language and display options.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.