# UsageStats

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Inherited Constants](https://developer.android.com/reference/android/app/usage/UsageStats#inhconstants)\|[Fields](https://developer.android.com/reference/android/app/usage/UsageStats#lfields)\|[Ctors](https://developer.android.com/reference/android/app/usage/UsageStats#pubctors)\|[Methods](https://developer.android.com/reference/android/app/usage/UsageStats#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/app/usage/UsageStats#inhmethods)  

# UsageStats

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/app/usage/UsageStats "View this page in Kotlin")\|Java

`
public

final

class
UsageStats
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


implements

`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`


`

|---|------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.app.usage.UsageStats |

<br />

*** ** * ** ***

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

## Summary

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ### Inherited constants                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor.                                                                                                                                            | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): 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)`". | |

|                                                                                                                                           ### Fields                                                                                                                                            ||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| ` public static final `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)`>` | [CREATOR](https://developer.android.com/reference/android/app/usage/UsageStats#CREATOR) <br /> |

|                                                                                                     ### Public constructors                                                                                                      ||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats#UsageStats(android.app.usage.UsageStats))`(`[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)` stats) ` |

|                                                                                                                                                                                                   ### Public methods                                                                                                                                                                                                   ||
|-----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` void`                                                               | ` `[add](https://developer.android.com/reference/android/app/usage/UsageStats#add(android.app.usage.UsageStats))`(`[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)` right) ` Add the statistics from the right[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)to the left. |
| ` int`                                                                | ` `[describeContents](https://developer.android.com/reference/android/app/usage/UsageStats#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                                                                                                     |
| ` long`                                                               | ` `[getFirstTimeStamp](https://developer.android.com/reference/android/app/usage/UsageStats#getFirstTimeStamp())`() ` Get the beginning of the time range this[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)represents, measured in milliseconds since the epoch.                                           |
| ` long`                                                               | ` `[getLastTimeForegroundServiceUsed](https://developer.android.com/reference/android/app/usage/UsageStats#getLastTimeForegroundServiceUsed())`() ` Get the last time this package's foreground service was used, measured in milliseconds since the epoch.                                                                                     |
| ` long`                                                               | ` `[getLastTimeStamp](https://developer.android.com/reference/android/app/usage/UsageStats#getLastTimeStamp())`() ` Get the end of the time range this[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)represents, measured in milliseconds since the epoch.                                                   |
| ` long`                                                               | ` `[getLastTimeUsed](https://developer.android.com/reference/android/app/usage/UsageStats#getLastTimeUsed())`() ` Get the last time this package's activity was used, measured in milliseconds since the epoch.                                                                                                                                 |
| ` long`                                                               | ` `[getLastTimeVisible](https://developer.android.com/reference/android/app/usage/UsageStats#getLastTimeVisible())`() ` Get the last time this package's activity is visible in the UI, measured in milliseconds since the epoch.                                                                                                               |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getPackageName](https://developer.android.com/reference/android/app/usage/UsageStats#getPackageName())`() `                                                                                                                                                                                                                                 |
| ` long`                                                               | ` `[getTotalTimeForegroundServiceUsed](https://developer.android.com/reference/android/app/usage/UsageStats#getTotalTimeForegroundServiceUsed())`() ` Get the total time this package's foreground services are started, measured in milliseconds.                                                                                              |
| ` long`                                                               | ` `[getTotalTimeInForeground](https://developer.android.com/reference/android/app/usage/UsageStats#getTotalTimeInForeground())`() ` Get the total time this package spent in the foreground, measured in milliseconds.                                                                                                                          |
| ` long`                                                               | ` `[getTotalTimeVisible](https://developer.android.com/reference/android/app/usage/UsageStats#getTotalTimeVisible())`() ` Get the total time this package's activity is visible in the UI, measured in milliseconds.                                                                                                                            |
| ` void`                                                               | ` `[writeToParcel](https://developer.android.com/reference/android/app/usage/UsageStats#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel.                                                                                  |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int`  | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                    | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||

## Fields

### CREATOR

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static final Creator<UsageStats> CREATOR
```

<br />

<br />

## Public constructors

### UsageStats

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public UsageStats (UsageStats stats)
```

<br />

<br />

|          Parameters          ||
|---------|---------------------|
| `stats` | `UsageStats` <br /> |

## Public methods

### add

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void add (UsageStats right)
```

Add the statistics from the right[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)to the left. The package name for both[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)objects must be the same.

<br />

|                                                                    Parameters                                                                     ||
|---------|------------------------------------------------------------------------------------------------------------------------------------------|
| `right` | `UsageStats`: The[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)object to merge into this one. <br /> |

|                                                                                                                     Throws                                                                                                                      ||
|--------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | if the package names of the two[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)objects are different. |

### describeContents

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of[writeToParcel(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.

<br />

|                                                                                                                         Returns                                                                                                                         ||
|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) <br /> |

### getFirstTimeStamp

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getFirstTimeStamp ()
```

Get the beginning of the time range this[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)represents, measured in milliseconds since the epoch.

<br />

See[System.currentTimeMillis()](https://developer.android.com/reference/java/lang/System#currentTimeMillis()).

<br />

<br />

|    Returns     ||
|--------|--------|
| `long` | <br /> |

### getLastTimeForegroundServiceUsed

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getLastTimeForegroundServiceUsed ()
```

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

<br />

See[System.currentTimeMillis()](https://developer.android.com/reference/java/lang/System#currentTimeMillis()).

<br />

<br />

|    Returns     ||
|--------|--------|
| `long` | <br /> |

### getLastTimeStamp

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getLastTimeStamp ()
```

Get the end of the time range this[UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats)represents, measured in milliseconds since the epoch.

<br />

See[System.currentTimeMillis()](https://developer.android.com/reference/java/lang/System#currentTimeMillis()).

<br />

<br />

|    Returns     ||
|--------|--------|
| `long` | <br /> |

### getLastTimeUsed

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getLastTimeUsed ()
```

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

<br />

See[System.currentTimeMillis()](https://developer.android.com/reference/java/lang/System#currentTimeMillis()).

<br />

<br />

|    Returns     ||
|--------|--------|
| `long` | <br /> |

### getLastTimeVisible

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getLastTimeVisible ()
```

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

<br />

|    Returns     ||
|--------|--------|
| `long` | <br /> |

### getPackageName

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String getPackageName ()
```

<br />

<br />

|                                  Returns                                   ||
|--------------------------------------------------------------------|--------|
| [String](https://developer.android.com/reference/java/lang/String) | <br /> |

### getTotalTimeForegroundServiceUsed

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getTotalTimeForegroundServiceUsed ()
```

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

<br />

|    Returns     ||
|--------|--------|
| `long` | <br /> |

### getTotalTimeInForeground

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getTotalTimeInForeground ()
```

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.

<br />

|    Returns     ||
|--------|--------|
| `long` | <br /> |

### getTotalTimeVisible

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getTotalTimeVisible ()
```

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.

<br />

|    Returns     ||
|--------|--------|
| `long` | <br /> |

### writeToParcel

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

|                                                                                                                                                                                                                               Parameters                                                                                                                                                                                                                                ||
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dest`  | `Parcel`: The Parcel in which the object should be written. This value cannot be`null`. <br />                                                                                                                                                                                                                                                                                                                                                                 |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES <br /> |