Register now for Android Dev Summit 2019!

AppLaunchChecker

open class AppLaunchChecker
kotlin.Any
   ↳ androidx.core.app.AppLaunchChecker

This class provides APIs for determining how an app has been launched. This can be useful if you want to confirm that a user has launched your app through its front door activity from their launcher/home screen, rather than just if the app has been opened in the past in order to view a link, open a document or perform some other service for other apps on the device.

Summary

Public constructors

Public methods

open static Boolean
hasStartedFromLauncher(@NonNull context: Context)

Checks if this app has been launched by the user from their launcher or home screen since it was installed.

open static Unit
onActivityCreate(@NonNull activity: Activity)

Records the parameters of an activity's launch for later use by the other methods available on this class.

Public constructors

<init>

AppLaunchChecker()

Deprecated: This type should not be instantiated as it contains only static methods.

Public methods

hasStartedFromLauncher

open static fun hasStartedFromLauncher(@NonNull context: Context): Boolean

Checks if this app has been launched by the user from their launcher or home screen since it was installed.

To track this state properly you must call onActivityCreate(Activity) in your launcher activity's Activity#onCreate(Bundle) method.

Parameters
context Context: Context to check
Return
Boolean: true if this app has been started by the user from the launcher at least once

onActivityCreate

open static fun onActivityCreate(@NonNull activity: Activity): Unit

Records the parameters of an activity's launch for later use by the other methods available on this class.

Your app should call this method in your launcher activity's Activity#onCreate(Bundle) method to track launch state. If the app targets API 23 (Android 6.0 Marshmallow) or later, this state will be eligible for full data backup and may be restored to the user's device automatically.

*
Parameters
activity Activity: the Activity currently running onCreate