ActivityOptionsCompat

Added in 1.1.0

class ActivityOptionsCompat

Helper for accessing features in android.app.ActivityOptions in a backwards compatible fashion.

Summary

Constants
const String!
EXTRA_USAGE_TIME_REPORT = "android.activity.usage_time"

A long in the extras delivered by requestUsageTimeReport that contains the total time (in ms) the user spent in the app flow.
const String!
EXTRA_USAGE_TIME_REPORT_PACKAGES = "android.usage_time_packages"

A Bundle in the extras delivered by requestUsageTimeReport 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).

Protected constructors

Public functions
Rect?

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

Gets the id of the display where activity should be launched.
java-static ActivityOptionsCompat

Create a basic ActivityOptions that has no special animation associated with it.
java-static ActivityOptionsCompat
makeClipRevealAnimation(
    source: View,
    startX: Int,
    startY: Int,
    width: Int,
    height: Int
)

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.
java-static ActivityOptionsCompat
makeCustomAnimation(context: Context, enterResId: Int, exitResId: Int)

Create an ActivityOptions specifying a custom animation to run when the activity is displayed.
java-static ActivityOptionsCompat
makeScaleUpAnimation(
    source: View,
    startX: Int,
    startY: Int,
    startWidth: Int,
    startHeight: Int
)

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.
java-static ActivityOptionsCompat
makeSceneTransitionAnimation(
    activity: Activity,
    sharedElements: Array<Pair<View!, String!>!>?
)

Create an ActivityOptions to transition between Activities using cross-Activity scene animations.
java-static ActivityOptionsCompat
makeSceneTransitionAnimation(
    activity: Activity,
    sharedElement: View,
    sharedElementName: String
)

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

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.
java-static ActivityOptionsCompat
makeThumbnailScaleUpAnimation(
    source: View,
    thumbnail: Bitmap,
    startX: Int,
    startY: Int
)

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

Ask the the system track that time the user spends in the app being launched, and report it back once done.
ActivityOptionsCompat
setLaunchBounds(screenSpacePixelRect: Rect?)

Sets the bounds (window size) that the activity should be launched in.
ActivityOptionsCompat
setLaunchDisplayId(launchDisplayId: Int)

Sets the id of the display where the activity should be launched.
ActivityOptionsCompat

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

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

Returns the created options as a Bundle, which can be passed to startActivity.
Unit

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

Constants

EXTRA_USAGE_TIME_REPORT

Added in 1.1.0
const val EXTRA_USAGE_TIME_REPORT = "android.activity.usage_time": String!

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

EXTRA_USAGE_TIME_REPORT_PACKAGES

Added in 1.1.0
const val EXTRA_USAGE_TIME_REPORT_PACKAGES = "android.usage_time_packages": String!

A Bundle in the extras delivered by requestUsageTimeReport 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).

Protected constructors

ActivityOptionsCompat

Added in 1.1.0
protected ActivityOptionsCompat()

Public functions

getLaunchBounds

Added in 1.1.0
fun getLaunchBounds(): Rect?

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

Returns
Rect?

Bounds used to launch the activity.
See also
setLaunchBounds

getLaunchDisplayId

fun getLaunchDisplayId(): Int

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

On API 25 and below, this method always returns INVALID_DISPLAY.

Returns
Int

The id of the display where activity should be launched, INVALID_DISPLAY if not set.
See also
setLaunchDisplayId

makeBasic

Added in 1.1.0
java-static fun makeBasic(): ActivityOptionsCompat

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

makeClipRevealAnimation

Added in 1.1.0
java-static fun makeClipRevealAnimation(
    source: View,
    startX: Int,
    startY: Int,
    width: Int,
    height: Int
): ActivityOptionsCompat

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
ActivityOptionsCompat

Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

makeCustomAnimation

Added in 1.1.0
java-static fun makeCustomAnimation(context: Context, enterResId: Int, exitResId: Int): ActivityOptionsCompat

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
ActivityOptionsCompat

Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

makeScaleUpAnimation

Added in 1.1.0
java-static fun makeScaleUpAnimation(
    source: View,
    startX: Int,
    startY: Int,
    startWidth: Int,
    startHeight: Int
): ActivityOptionsCompat

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 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.
startWidth: Int

The initial width of the new activity.
startHeight: Int

The initial height of the new activity.
Returns
ActivityOptionsCompat

Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

makeSceneTransitionAnimation

java-static fun makeSceneTransitionAnimation(
    activity: Activity,
    sharedElements: Array<Pair<View!, String!>!>?
): ActivityOptionsCompat

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_CONTENT_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: Array<Pair<View!, String!>!>?

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
ActivityOptionsCompat

Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

makeSceneTransitionAnimation

Added in 1.1.0
java-static fun makeSceneTransitionAnimation(
    activity: Activity,
    sharedElement: View,
    sharedElementName: String
): ActivityOptionsCompat

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_CONTENT_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. sharedElement must have a non-null sharedElementName.
sharedElementName: String

The shared element name as used in the target Activity. This may be null if it has the same name as sharedElement.
Returns
ActivityOptionsCompat

Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

makeTaskLaunchBehind

Added in 1.1.0
java-static fun makeTaskLaunchBehind(): ActivityOptionsCompat

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

Added in 1.1.0
java-static fun makeThumbnailScaleUpAnimation(
    source: View,
    thumbnail: Bitmap,
    startX: Int,
    startY: Int
): ActivityOptionsCompat

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

Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

requestUsageTimeReport

Added in 1.1.0
fun requestUsageTimeReport(receiver: PendingIntent): Unit

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 will receive the report.

setLaunchBounds

Added in 1.1.0
fun setLaunchBounds(screenSpacePixelRect: Rect?): ActivityOptionsCompat

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.

setLaunchDisplayId

fun setLaunchDisplayId(launchDisplayId: Int): ActivityOptionsCompat

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

On API 25 and below, calling this method has no effect.

Parameters
launchDisplayId: Int

The id of the display where the activity should be launched.
Returns
ActivityOptionsCompat

thisActivityOptions instance.

setPendingIntentBackgroundActivityStartMode

Added in 1.15.0
fun setPendingIntentBackgroundActivityStartMode(state: Int): ActivityOptionsCompat

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

This is typically used in when executing send 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.

setShareIdentityEnabled

Added in 1.13.0
fun setShareIdentityEnabled(shareIdentity: Boolean): ActivityOptionsCompat

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. This is a no-op before U.

Note, even if the launching app does not explicitly enable sharing of its identity, if the activity is started with Activity#startActivityForResult, then 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.

Parameters
shareIdentity: Boolean

whether the launching app's identity should be shared with the activity
Returns
ActivityOptionsCompat

thisActivityOptions instance.
See also
getLaunchedFromPackage
getLaunchedFromUid

toBundle

Added in 1.1.0
fun toBundle(): Bundle?

Returns the created options as a Bundle, which can be passed to startActivity. 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

Added in 1.1.0
fun update(otherOptions: ActivityOptionsCompat): Unit

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