UsageStats

Kotlin |Java

class UsageStats : Parcelable

kotlin.Any
↳	android.app.usage.UsageStats

Contains usage statistics for an app package for a specific time range.

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`UsageStats(stats: UsageStats!)`

Public methods
Unit	`add(right: UsageStats!)` Add the statistics from the right `UsageStats` to the left.
Int	`describeContents()`
Long	`getFirstTimeStamp()` Get the beginning of the time range this `android.app.usage.UsageStats` represents, measured in milliseconds since the epoch.
Long	`getLastTimeForegroundServiceUsed()` Get the last time this package's foreground service was used, measured in milliseconds since the epoch.
Long	`getLastTimeStamp()` Get the end of the time range this `android.app.usage.UsageStats` represents, measured in milliseconds since the epoch.
Long	`getLastTimeUsed()` Get the last time this package's activity was used, measured in milliseconds since the epoch.
Long	`getLastTimeVisible()` Get the last time this package's activity is visible in the UI, measured in milliseconds since the epoch.
String!	`getPackageName()`
Long	`getTotalTimeForegroundServiceUsed()` Get the total time this package's foreground services are started, measured in milliseconds.
Long	`getTotalTimeInForeground()` Get the total time this package spent in the foreground, measured in milliseconds.
Long	`getTotalTimeVisible()` Get the total time this package's activity is visible in the UI, measured in milliseconds.
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<UsageStats!>	`CREATOR`

Public constructors

UsageStats

Added in API level 21

UsageStats(stats: UsageStats!)

Public methods

add

Added in API level 21

fun add(right: UsageStats!): Unit

Add the statistics from the right UsageStats to the left. The package name for both UsageStats objects must be the same.

Parameters
`right`	UsageStats!: The `UsageStats` object to merge into this one.

Exceptions
`java.lang.IllegalArgumentException`	if the package names of the two `UsageStats` objects are different.

describeContents

Added in API level 21

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getFirstTimeStamp

Added in API level 21

fun getFirstTimeStamp(): Long

Get the beginning of the time range this android.app.usage.UsageStats represents, measured in milliseconds since the epoch.

See System.currentTimeMillis().

getLastTimeForegroundServiceUsed

Added in API level 29

fun getLastTimeForegroundServiceUsed(): Long

Get the last time this package's foreground service was used, measured in milliseconds since the epoch.

See System.currentTimeMillis().

getLastTimeStamp

Added in API level 21

fun getLastTimeStamp(): Long

Get the end of the time range this android.app.usage.UsageStats represents, measured in milliseconds since the epoch.

See System.currentTimeMillis().

getLastTimeUsed

Added in API level 21

fun getLastTimeUsed(): Long

Get the last time this package's activity was used, measured in milliseconds since the epoch.

See System.currentTimeMillis().

getLastTimeVisible

Added in API level 29

fun getLastTimeVisible(): Long

Get the last time this package's activity is visible in the UI, measured in milliseconds since the epoch.

getPackageName

Added in API level 21

fun getPackageName(): String!

getTotalTimeForegroundServiceUsed

Added in API level 29

fun getTotalTimeForegroundServiceUsed(): Long

Get the total time this package's foreground services are started, measured in milliseconds.

getTotalTimeInForeground

Added in API level 21

fun getTotalTimeInForeground(): Long

Get the total time this package spent in the foreground, measured in milliseconds. When in the foreground, the user is actively interacting with the app.

getTotalTimeVisible

Added in API level 29

fun getTotalTimeVisible(): Long

Get the total time this package's activity is visible in the UI, measured in milliseconds. Note: An app may be visible but not considered foreground. Apps in the foreground must be visible, so visible time includes time in the foreground.

writeToParcel

Added in API level 21

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Parameters
`dest`	Parcel: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 21

static val CREATOR: Parcelable.Creator<UsageStats!>