ActivityOptions

EXTRA_USAGE_TIME_REPORT

static val EXTRA_USAGE_TIME_REPORT: String

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

Value: "android.activity.usage_time"

EXTRA_USAGE_TIME_REPORT_PACKAGES

static val EXTRA_USAGE_TIME_REPORT_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).

Value: "android.usage_time_packages"

getLaunchBounds

open fun getLaunchBounds(): Rect?

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

getLaunchDisplayId

open fun getLaunchDisplayId(): Int

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

getLockTaskMode

open fun getLockTaskMode(): Boolean

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

makeBasic

open static fun makeBasic(): ActivityOptions!

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

makeClipRevealAnimation

open static fun makeClipRevealAnimation(
    source: View!, 
    startX: Int, 
    startY: Int, 
    width: Int, 
    height: Int
): ActivityOptions!

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

open static fun makeCustomAnimation(
    context: Context!, 
    enterResId: Int, 
    exitResId: Int
): ActivityOptions!

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

makeScaleUpAnimation

open static fun makeScaleUpAnimation(
    source: View!, 
    startX: Int, 
    startY: Int, 
    width: Int, 
    height: Int
): ActivityOptions!

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

open static fun makeSceneTransitionAnimation(
    activity: Activity!, 
    sharedElement: View!, 
    sharedElementName: String!
): ActivityOptions!

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 android.view.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

@SafeVarargs open static fun makeSceneTransitionAnimation(
    activity: Activity!, 
    vararg sharedElements: Pair<View!, String!>!
): ActivityOptions!

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 android.view.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

open static fun makeTaskLaunchBehind(): ActivityOptions!

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

open static fun makeThumbnailScaleUpAnimation(
    source: View!, 
    thumbnail: Bitmap!, 
    startX: Int, 
    startY: Int
): ActivityOptions!

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

open fun requestUsageTimeReport(receiver: PendingIntent!): Unit

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.

setAppVerificationBundle

open fun setAppVerificationBundle(bundle: Bundle!): ActivityOptions!

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

setLaunchBounds

open fun setLaunchBounds(screenSpacePixelRect: Rect?): ActivityOptions!

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 android.content.pm.PackageManager#FEATURE_FREEFORM_WINDOW_MANAGEMENT or android.content.pm.PackageManager#FEATURE_PICTURE_IN_PICTURE enabled.

setLaunchDisplayId

open fun setLaunchDisplayId(launchDisplayId: Int): ActivityOptions!

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 android.content.pm.PackageManager#FEATURE_ACTIVITIES_ON_SECONDARY_DISPLAYS.

setLockTaskEnabled

open fun setLockTaskEnabled(lockTaskMode: Boolean): ActivityOptions!

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 android.app.admin.DevicePolicyManager can run in LockTask mode. Therefore, if android.app.admin.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 — relaunch the activity to run in lock task mode. Defaults to false if not set.

toBundle

open fun toBundle(): Bundle!

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

open fun update(otherOptions: ActivityOptions!): Unit

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