Most visited

Recently visited

Results for

Added in API level 21

Summary: Constants | Methods | Inherited Methods | [Expand All]

UsageStatsManager

public final class UsageStatsManager
extends Object

java.lang.Object
↳	android.app.usage.UsageStatsManager

Provides access to device usage history and statistics. Usage data is aggregated into time intervals: days, weeks, months, and years.

When requesting usage data since a particular time, the request might look something like this:

 PAST                   REQUEST_TIME                    TODAY                   FUTURE
 ————————————————————————————||———————————————————————————¦-----------------------|
                        YEAR ||                           ¦                       |
 ————————————————————————————||———————————————————————————¦-----------------------|
  MONTH            |         ||                MONTH      ¦                       |
 ——————————————————|—————————||———————————————————————————¦-----------------------|
   |      WEEK     |     WEEK||    |     WEEK     |     WE¦EK     |      WEEK     |
 ————————————————————————————||———————————————————|———————¦-----------------------|
                             ||           |DAY|DAY|DAY|DAY¦DAY|DAY|DAY|DAY|DAY|DAY|
 ————————————————————————————||———————————————————————————¦-----------------------|

A request for data in the middle of a time interval will include that interval.

NOTE: This API requires the permission android.permission.PACKAGE_USAGE_STATS, which is a system-level permission and will not be granted to third-party apps. However, declaring the permission implies intention to use the API and the user of the device can grant permission through the Settings application.

Summary

Constants
`int`	`INTERVAL_BEST` An interval type that will use the best fit interval for the given time range.
`int`	`INTERVAL_DAILY` An interval type that spans a day.
`int`	`INTERVAL_MONTHLY` An interval type that spans a month.
`int`	`INTERVAL_WEEKLY` An interval type that spans a week.
`int`	`INTERVAL_YEARLY` An interval type that spans a year.

Public methods
`boolean`	`isAppInactive(String packageName)` Returns whether the specified app is currently considered inactive.
`Map<String, UsageStats>`	`queryAndAggregateUsageStats(long beginTime, long endTime)` A convenience method that queries for all stats in the given range (using the best interval for that range), merges the resulting data, and keys it by package name.
`List<ConfigurationStats>`	`queryConfigurations(int intervalType, long beginTime, long endTime)` Gets the hardware configurations the device was in for the given time range, aggregated by the specified interval.
`UsageEvents`	`queryEvents(long beginTime, long endTime)` Query for events in the given time range.
`List<UsageStats>`	`queryUsageStats(int intervalType, long beginTime, long endTime)` Gets application usage stats for the given time range, aggregated by the specified interval.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

INTERVAL_BEST

Added in API level 21

int INTERVAL_BEST

An interval type that will use the best fit interval for the given time range. See queryUsageStats(int, long, long).

Constant Value: 4 (0x00000004)

INTERVAL_DAILY

Added in API level 21

int INTERVAL_DAILY

An interval type that spans a day. See queryUsageStats(int, long, long).

Constant Value: 0 (0x00000000)

INTERVAL_MONTHLY

Added in API level 21

int INTERVAL_MONTHLY

An interval type that spans a month. See queryUsageStats(int, long, long).

Constant Value: 2 (0x00000002)

INTERVAL_WEEKLY

Added in API level 21

int INTERVAL_WEEKLY

An interval type that spans a week. See queryUsageStats(int, long, long).

Constant Value: 1 (0x00000001)

INTERVAL_YEARLY

Added in API level 21

int INTERVAL_YEARLY

An interval type that spans a year. See queryUsageStats(int, long, long).

Constant Value: 3 (0x00000003)

Public methods

isAppInactive

Added in API level 23

boolean isAppInactive (String packageName)

Returns whether the specified app is currently considered inactive. This will be true if the app hasn't been used directly or indirectly for a period of time defined by the system. This could be of the order of several hours or days.

Parameters
`packageName`	`String`: The package name of the app to query

Returns
`boolean`	whether the app is currently considered inactive

queryAndAggregateUsageStats

Added in API level 21

Map<String, UsageStats> queryAndAggregateUsageStats (long beginTime, 
                long endTime)

A convenience method that queries for all stats in the given range (using the best interval for that range), merges the resulting data, and keys it by package name. See queryUsageStats(int, long, long).

Parameters
`beginTime`	`long`: The inclusive beginning of the range of stats to include in the results.
`endTime`	`long`: The exclusive end of the range of stats to include in the results.

Returns
`Map<String, UsageStats>`	A `Map` keyed by package name, or null if no stats are available.

queryConfigurations

Added in API level 21

List<ConfigurationStats> queryConfigurations (int intervalType, 
                long beginTime, 
                long endTime)

Gets the hardware configurations the device was in for the given time range, aggregated by the specified interval. The results are ordered as in queryUsageStats(int, long, long).

Parameters
`intervalType`	`int`: The time interval by which the stats are aggregated.
`beginTime`	`long`: The inclusive beginning of the range of stats to include in the results.
`endTime`	`long`: The exclusive end of the range of stats to include in the results.

Returns
`List<ConfigurationStats>`	A list of `ConfigurationStats` or null if none are available.

queryEvents

Added in API level 21

UsageEvents queryEvents (long beginTime, 
                long endTime)

Query for events in the given time range. Events are only kept by the system for a few days.

NOTE: The last few minutes of the event log will be truncated to prevent abuse by applications.

Parameters
`beginTime`	`long`: The inclusive beginning of the range of events to include in the results.
`endTime`	`long`: The exclusive end of the range of events to include in the results.

Returns
`UsageEvents`	A `UsageEvents`.

queryUsageStats

Added in API level 21

List<UsageStats> queryUsageStats (int intervalType, 
                long beginTime, 
                long endTime)

Gets application usage stats for the given time range, aggregated by the specified interval.

The returned list will contain a UsageStats object for each package that has data for an interval that is a subset of the time range given. To illustrate:

 intervalType = INTERVAL_YEARLY
 beginTime = 2013
 endTime = 2015 (exclusive)

 Results:
 2013 - com.example.alpha
 2013 - com.example.beta
 2014 - com.example.alpha
 2014 - com.example.beta
 2014 - com.example.charlie

Parameters
`intervalType`	`int`: The time interval by which the stats are aggregated.
`beginTime`	`long`: The inclusive beginning of the range of stats to include in the results.
`endTime`	`long`: The exclusive end of the range of stats to include in the results.

Returns
`List<UsageStats>`	A list of `UsageStats` or null if none are available.

See also: