Package org.robolectric.shadows

Class ShadowUsageStatsManager

java.lang.Object

org.robolectric.shadows.ShadowUsageStatsManager

@Implements(value=android.app.usage.UsageStatsManager.class,
            minSdk=21)
public class ShadowUsageStatsManager
extends Object

Shadow of UsageStatsManager.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShadowUsageStatsManager.AppUsageLimitObserver	App usage limit observer registered via UsageStatsManager.registerAppUsageLimitObserver(int, String[], Duration, Duration, PendingIntent).
static class	ShadowUsageStatsManager.AppUsageObserver	App usage observer registered via UsageStatsManager.registerAppUsageObserver(int, String[], long, TimeUnit, PendingIntent).
static class	ShadowUsageStatsManager.EventBuilder	Builder for constructing UsageEvents.Event objects.
static class	ShadowUsageStatsManager.UsageSessionObserver	Usage session observer registered via UsageStatsManager#registerUsageSessionObserver(int, String[], long, TimeUnit, long, TimeUnit, PendingIntent, PendingIntent).
static class	ShadowUsageStatsManager.UsageStatsBuilder	Builder for constructing UsageStats objects.

Field Summary

Fields

Modifier and Type	Field	Description
protected static Map<Integer,ShadowUsageStatsManager.UsageSessionObserver>	usageSessionObserversById

Constructor Summary

Constructors

Constructor	Description
ShadowUsageStatsManager()

Method Summary

Modifier and Type	Method	Description
void	addEvent(UsageEvents.Event event)	Adds an event to be returned by UsageStatsManager.queryEvents(long, long).
void	addEvent(String packageName, long timeStamp, int eventType)	Deprecated. Use addEvent(Event) and ShadowUsageStatsManager.EventBuilder instead.
void	addUsageStats(int intervalType, UsageStats stats)	Adds an aggregated UsageStats object, to be returned by queryUsageStats(int, long, long).
protected int	getAppStandbyBucket()	Returns the current app's standby bucket that is set by setCurrentAppStandbyBucket.
int	getAppStandbyBucket(String packageName)	Returns the current standby bucket of the specified app that is set by setAppStandbyBucket.
Map<String,Integer>	getAppStandbyBuckets()
com.google.common.collect.ImmutableList<ShadowUsageStatsManager.AppUsageLimitObserver>	getRegisteredAppUsageLimitObservers()	Returns the ShadowUsageStatsManager.AppUsageLimitObservers currently registered in UsageStatsManager.
Collection<ShadowUsageStatsManager.AppUsageObserver>	getRegisteredAppUsageObservers()	Returns the ShadowUsageStatsManager.AppUsageObservers currently registered in UsageStatsManager.
List<ShadowUsageStatsManager.UsageSessionObserver>	getRegisteredUsageSessionObservers()	Returns the ShadowUsageStatsManager.UsageSessionObservers currently registered in UsageStatsManager.
protected int	getUsageSource()
protected UsageEvents	queryEvents(long beginTime, long endTime)
protected UsageEvents	queryEventsForSelf(long beginTime, long endTime)
protected List<UsageStats>	queryUsageStats(int intervalType, long beginTime, long endTime)	Returns aggregated UsageStats added by calling addUsageStats(int, android.app.usage.UsageStats).
protected void	registerAppUsageLimitObserver(int observerId, String[] observedEntities, Duration timeLimit, Duration timeUsed, PendingIntent callbackIntent)	Registers an app usage limit observer that receives a callback on callbackIntent when the sum of usages of apps and tokens in observedEntities exceeds timeLimit - timeUsed.
protected void	registerAppUsageObserver(int observerId, String[] packages, long timeLimit, TimeUnit timeUnit, PendingIntent callbackIntent)
protected void	registerUsageSessionObserver(int observerId, String[] packages, Duration sessionStepDuration, Duration thresholdTimeDuration, PendingIntent sessionStepTriggeredIntent, PendingIntent sessionEndedIntent)
static void	reset()
void	setAppStandbyBucket(String packageName, int bucket)	Sets the standby bucket of the specified app.
void	setAppStandbyBuckets(Map<String,Integer> appBuckets)
void	setCurrentAppStandbyBucket(int bucket)	Sets the current app's standby bucket
void	setUsageSource(int usageSource)	Sets what app usage observers will consider the source of usage for an activity.
void	simulateTimeChange(long offsetToAddInMillis)	Simulates the operations done by the framework when there is a time change.
void	triggerRegisteredAppUsageLimitObserver(int observerId, Duration timeUsed)	Triggers a currently registered ShadowUsageStatsManager.AppUsageLimitObserver with observerId.
void	triggerRegisteredAppUsageObserver(int observerId, long timeUsedInMillis)	Triggers a currently registered ShadowUsageStatsManager.AppUsageObserver with observerId.
void	triggerRegisteredSessionEndedObserver(int observerId)	Triggers a currently registered ShadowUsageStatsManager.UsageSessionObserver with observerId.
void	triggerRegisteredSessionStepObserver(int observerId, long timeUsedInMillis)	Triggers a currently registered ShadowUsageStatsManager.UsageSessionObserver with observerId.
protected void	unregisterAppUsageLimitObserver(int observerId)	Unregisters the app usage limit observer specified by observerId.
protected void	unregisterAppUsageObserver(int observerId)
protected void	unregisterUsageSessionObserver(int observerId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

usageSessionObserversById

protected static final Map<Integer,ShadowUsageStatsManager.UsageSessionObserver> usageSessionObserversById

Constructor Detail

ShadowUsageStatsManager

public ShadowUsageStatsManager()

Method Detail

queryEvents

@Implementation
protected UsageEvents queryEvents(long beginTime,
                                  long endTime)

queryEventsForSelf

@Implementation(minSdk=28)
protected UsageEvents queryEventsForSelf(long beginTime,
                                         long endTime)

addEvent

@Deprecated
public void addEvent(String packageName,
                     long timeStamp,
                     int eventType)

Deprecated. Use addEvent(Event) and ShadowUsageStatsManager.EventBuilder instead.

Adds an event to be returned by UsageStatsManager.queryEvents(long, long).

This method won't affect the results of queryUsageStats(int, long, long) method.

addEvent

public void addEvent(UsageEvents.Event event)

Adds an event to be returned by UsageStatsManager.queryEvents(long, long).

This method won't affect the results of queryUsageStats(int, long, long) method.

The UsageEvents.Event can be built by ShadowUsageStatsManager.EventBuilder.

simulateTimeChange

public void simulateTimeChange(long offsetToAddInMillis)

Simulates the operations done by the framework when there is a time change. If the time is changed, the timestamps of all existing usage events will be shifted by the same offset as the time change, in order to make sure they remain stable relative to the new time.

This method won't affect the results of queryUsageStats(int, long, long) method.

Parameters:

offsetToAddInMillis - the offset to be applied to all events. For example, if offsetInMillis is 60,000, then all UsageEvents.Events will be shifted forward by 1 minute (into the future). Likewise, if offsetInMillis is -60,000, then all UsageEvents.Events will be shifted backward by 1 minute (into the past).

queryUsageStats

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

Returns aggregated UsageStats added by calling addUsageStats(int, android.app.usage.UsageStats).

The real implementation creates these aggregated objects from individual UsageEvents.Event. This aggregation logic is nontrivial, so the shadow implementation just returns the aggregate data added using addUsageStats(int, android.app.usage.UsageStats).

addUsageStats

public void addUsageStats(int intervalType,
                          UsageStats stats)

Adds an aggregated UsageStats object, to be returned by queryUsageStats(int, long, long). Construct these objects with ShadowUsageStatsManager.UsageStatsBuilder, and set the firstTimestamp and lastTimestamp fields to make time filtering work in queryUsageStats(int, long, long).

Parameters:

intervalType - An interval type constant, e.g. UsageStatsManager.INTERVAL_WEEKLY.

getAppStandbyBucket

@Implementation(minSdk=28)
@HiddenApi
public int getAppStandbyBucket(String packageName)

Returns the current standby bucket of the specified app that is set by setAppStandbyBucket. If the standby bucket value has never been set, return UsageStatsManager.STANDBY_BUCKET_ACTIVE.

getAppStandbyBuckets

@Implementation(minSdk=28)
@HiddenApi
public Map<String,Integer> getAppStandbyBuckets()

setAppStandbyBucket

@Implementation(minSdk=28)
@HiddenApi
public void setAppStandbyBucket(String packageName,
                                int bucket)

Sets the standby bucket of the specified app.

setAppStandbyBuckets

@Implementation(minSdk=28)
@HiddenApi
public void setAppStandbyBuckets(Map<String,Integer> appBuckets)

registerAppUsageObserver

@Implementation(minSdk=28)
@HiddenApi
protected void registerAppUsageObserver(int observerId,
                                        String[] packages,
                                        long timeLimit,
                                        TimeUnit timeUnit,
                                        PendingIntent callbackIntent)

unregisterAppUsageObserver

@Implementation(minSdk=28)
@HiddenApi
protected void unregisterAppUsageObserver(int observerId)

getRegisteredAppUsageObservers

public Collection<ShadowUsageStatsManager.AppUsageObserver> getRegisteredAppUsageObservers()

Returns the ShadowUsageStatsManager.AppUsageObservers currently registered in UsageStatsManager.

triggerRegisteredAppUsageObserver

public void triggerRegisteredAppUsageObserver(int observerId,
                                              long timeUsedInMillis)

Triggers a currently registered ShadowUsageStatsManager.AppUsageObserver with observerId.

The observer will be no longer registered afterwards.

registerUsageSessionObserver

@Implementation(minSdk=29)
protected void registerUsageSessionObserver(int observerId,
                                            String[] packages,
                                            Duration sessionStepDuration,
                                            Duration thresholdTimeDuration,
                                            PendingIntent sessionStepTriggeredIntent,
                                            PendingIntent sessionEndedIntent)

unregisterUsageSessionObserver

@Implementation(minSdk=29)
protected void unregisterUsageSessionObserver(int observerId)

getRegisteredUsageSessionObservers

public List<ShadowUsageStatsManager.UsageSessionObserver> getRegisteredUsageSessionObservers()

Returns the ShadowUsageStatsManager.UsageSessionObservers currently registered in UsageStatsManager.

triggerRegisteredSessionStepObserver

public void triggerRegisteredSessionStepObserver(int observerId,
                                                 long timeUsedInMillis)

Triggers a currently registered ShadowUsageStatsManager.UsageSessionObserver with observerId.

The observer SHOULD be registered afterwards.

triggerRegisteredSessionEndedObserver

public void triggerRegisteredSessionEndedObserver(int observerId)

Triggers a currently registered ShadowUsageStatsManager.UsageSessionObserver with observerId.

The observer SHOULD be registered afterwards.

registerAppUsageLimitObserver

@Implementation(minSdk=29)
@HiddenApi
protected void registerAppUsageLimitObserver(int observerId,
                                             String[] observedEntities,
                                             Duration timeLimit,
                                             Duration timeUsed,
                                             PendingIntent callbackIntent)

Registers an app usage limit observer that receives a callback on callbackIntent when the sum of usages of apps and tokens in observedEntities exceeds timeLimit - timeUsed.

unregisterAppUsageLimitObserver

@Implementation(minSdk=29)
@HiddenApi
protected void unregisterAppUsageLimitObserver(int observerId)

Unregisters the app usage limit observer specified by observerId.

getRegisteredAppUsageLimitObservers

public com.google.common.collect.ImmutableList<ShadowUsageStatsManager.AppUsageLimitObserver> getRegisteredAppUsageLimitObservers()

Returns the ShadowUsageStatsManager.AppUsageLimitObservers currently registered in UsageStatsManager.

triggerRegisteredAppUsageLimitObserver

public void triggerRegisteredAppUsageLimitObserver(int observerId,
                                                   Duration timeUsed)

Triggers a currently registered ShadowUsageStatsManager.AppUsageLimitObserver with observerId.

The observer will still be registered afterwards.

getAppStandbyBucket

@Implementation(minSdk=28)
protected int getAppStandbyBucket()

Returns the current app's standby bucket that is set by setCurrentAppStandbyBucket. If the standby bucket value has never been set, return UsageStatsManager.STANDBY_BUCKET_ACTIVE.

setCurrentAppStandbyBucket

public void setCurrentAppStandbyBucket(int bucket)

Sets the current app's standby bucket

getUsageSource

@Implementation(minSdk=29)
@HiddenApi
protected int getUsageSource()

setUsageSource

public void setUsageSource(int usageSource)

Sets what app usage observers will consider the source of usage for an activity.

reset

@Resetter
public static void reset()