| /** |
| * Copyright (C) 2014 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| * use this file except in compliance with the License. You may obtain a copy |
| * of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| * License for the specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| package android.app.usage; |
| |
| import android.annotation.IntDef; |
| import android.annotation.NonNull; |
| import android.annotation.RequiresPermission; |
| import android.annotation.SystemApi; |
| import android.annotation.SystemService; |
| import android.annotation.UnsupportedAppUsage; |
| import android.app.PendingIntent; |
| import android.content.Context; |
| import android.content.pm.ParceledListSlice; |
| import android.os.Build; |
| import android.os.RemoteException; |
| import android.os.UserHandle; |
| import android.util.ArrayMap; |
| |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.util.ArrayList; |
| import java.util.Collections; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.concurrent.TimeUnit; |
| |
| /** |
| * Provides access to device usage history and statistics. Usage data is aggregated into |
| * time intervals: days, weeks, months, and years. |
| * <p /> |
| * When requesting usage data since a particular time, the request might look something like this: |
| * <pre> |
| * PAST REQUEST_TIME TODAY FUTURE |
| * ————————————————————————————||———————————————————————————¦-----------------------| |
| * YEAR || ¦ | |
| * ————————————————————————————||———————————————————————————¦-----------------------| |
| * MONTH | || MONTH ¦ | |
| * ——————————————————|—————————||———————————————————————————¦-----------------------| |
| * | WEEK | WEEK|| | WEEK | WE¦EK | WEEK | |
| * ————————————————————————————||———————————————————|———————¦-----------------------| |
| * || |DAY|DAY|DAY|DAY¦DAY|DAY|DAY|DAY|DAY|DAY| |
| * ————————————————————————————||———————————————————————————¦-----------------------| |
| * </pre> |
| * A request for data in the middle of a time interval will include that interval. |
| * <p/> |
| * <b>NOTE:</b> Most methods on this API require the permission |
| * android.permission.PACKAGE_USAGE_STATS. However, declaring the permission implies intention to |
| * use the API and the user of the device still needs to grant permission through the Settings |
| * application. |
| * See {@link android.provider.Settings#ACTION_USAGE_ACCESS_SETTINGS}. |
| * Methods which only return the information for the calling package do not require this permission. |
| * E.g. {@link #getAppStandbyBucket()} and {@link #queryEventsForSelf(long, long)}. |
| */ |
| @SystemService(Context.USAGE_STATS_SERVICE) |
| public final class UsageStatsManager { |
| |
| /** |
| * An interval type that spans a day. See {@link #queryUsageStats(int, long, long)}. |
| */ |
| public static final int INTERVAL_DAILY = 0; |
| |
| /** |
| * An interval type that spans a week. See {@link #queryUsageStats(int, long, long)}. |
| */ |
| public static final int INTERVAL_WEEKLY = 1; |
| |
| /** |
| * An interval type that spans a month. See {@link #queryUsageStats(int, long, long)}. |
| */ |
| public static final int INTERVAL_MONTHLY = 2; |
| |
| /** |
| * An interval type that spans a year. See {@link #queryUsageStats(int, long, long)}. |
| */ |
| public static final int INTERVAL_YEARLY = 3; |
| |
| /** |
| * An interval type that will use the best fit interval for the given time range. |
| * See {@link #queryUsageStats(int, long, long)}. |
| */ |
| public static final int INTERVAL_BEST = 4; |
| |
| /** |
| * The number of available intervals. Does not include {@link #INTERVAL_BEST}, since it |
| * is a pseudo interval (it actually selects a real interval). |
| * {@hide} |
| */ |
| public static final int INTERVAL_COUNT = 4; |
| |
| |
| /** |
| * The app is whitelisted for some reason and the bucket cannot be changed. |
| * {@hide} |
| */ |
| @SystemApi |
| public static final int STANDBY_BUCKET_EXEMPTED = 5; |
| |
| /** |
| * The app was used very recently, currently in use or likely to be used very soon. Standby |
| * bucket values that are ≤ {@link #STANDBY_BUCKET_ACTIVE} will not be throttled by the |
| * system while they are in this bucket. Buckets > {@link #STANDBY_BUCKET_ACTIVE} will most |
| * likely be restricted in some way. For instance, jobs and alarms may be deferred. |
| * @see #getAppStandbyBucket() |
| */ |
| public static final int STANDBY_BUCKET_ACTIVE = 10; |
| |
| /** |
| * The app was used recently and/or likely to be used in the next few hours. Restrictions will |
| * apply to these apps, such as deferral of jobs and alarms. |
| * @see #getAppStandbyBucket() |
| */ |
| public static final int STANDBY_BUCKET_WORKING_SET = 20; |
| |
| /** |
| * The app was used in the last few days and/or likely to be used in the next few days. |
| * Restrictions will apply to these apps, such as deferral of jobs and alarms. The delays may be |
| * greater than for apps in higher buckets (lower bucket value). Bucket values > |
| * {@link #STANDBY_BUCKET_FREQUENT} may additionally have network access limited. |
| * @see #getAppStandbyBucket() |
| */ |
| public static final int STANDBY_BUCKET_FREQUENT = 30; |
| |
| /** |
| * The app has not be used for several days and/or is unlikely to be used for several days. |
| * Apps in this bucket will have the most restrictions, including network restrictions, except |
| * during certain short periods (at a minimum, once a day) when they are allowed to execute |
| * jobs, access the network, etc. |
| * @see #getAppStandbyBucket() |
| */ |
| public static final int STANDBY_BUCKET_RARE = 40; |
| |
| /** |
| * The app has never been used. |
| * {@hide} |
| */ |
| @SystemApi |
| public static final int STANDBY_BUCKET_NEVER = 50; |
| |
| /** @hide */ |
| public static final int REASON_MAIN_MASK = 0xFF00; |
| /** @hide */ |
| public static final int REASON_MAIN_DEFAULT = 0x0100; |
| /** @hide */ |
| public static final int REASON_MAIN_TIMEOUT = 0x0200; |
| /** @hide */ |
| public static final int REASON_MAIN_USAGE = 0x0300; |
| /** @hide */ |
| public static final int REASON_MAIN_FORCED = 0x0400; |
| /** @hide */ |
| public static final int REASON_MAIN_PREDICTED = 0x0500; |
| |
| /** @hide */ |
| public static final int REASON_SUB_MASK = 0x00FF; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_SYSTEM_INTERACTION = 0x0001; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_NOTIFICATION_SEEN = 0x0002; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_USER_INTERACTION = 0x0003; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_MOVE_TO_FOREGROUND = 0x0004; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_MOVE_TO_BACKGROUND = 0x0005; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_SYSTEM_UPDATE = 0x0006; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_ACTIVE_TIMEOUT = 0x0007; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_SYNC_ADAPTER = 0x0008; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_SLICE_PINNED = 0x0009; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_SLICE_PINNED_PRIV = 0x000A; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_EXEMPTED_SYNC_SCHEDULED_NON_DOZE = 0x000B; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_EXEMPTED_SYNC_SCHEDULED_DOZE = 0x000C; |
| /** @hide */ |
| public static final int REASON_SUB_USAGE_EXEMPTED_SYNC_START = 0x000D; |
| |
| /** @hide */ |
| public static final int REASON_SUB_PREDICTED_RESTORED = 0x0001; |
| |
| |
| /** @hide */ |
| @IntDef(flag = false, prefix = { "STANDBY_BUCKET_" }, value = { |
| STANDBY_BUCKET_EXEMPTED, |
| STANDBY_BUCKET_ACTIVE, |
| STANDBY_BUCKET_WORKING_SET, |
| STANDBY_BUCKET_FREQUENT, |
| STANDBY_BUCKET_RARE, |
| STANDBY_BUCKET_NEVER, |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| public @interface StandbyBuckets {} |
| |
| /** |
| * Observer id of the registered observer for the group of packages that reached the usage |
| * time limit. Included as an extra in the PendingIntent that was registered. |
| * @hide |
| */ |
| @SystemApi |
| public static final String EXTRA_OBSERVER_ID = "android.app.usage.extra.OBSERVER_ID"; |
| |
| /** |
| * Original time limit in milliseconds specified by the registered observer for the group of |
| * packages that reached the usage time limit. Included as an extra in the PendingIntent that |
| * was registered. |
| * @hide |
| */ |
| @SystemApi |
| public static final String EXTRA_TIME_LIMIT = "android.app.usage.extra.TIME_LIMIT"; |
| |
| /** |
| * Actual usage time in milliseconds for the group of packages that reached the specified time |
| * limit. Included as an extra in the PendingIntent that was registered. |
| * @hide |
| */ |
| @SystemApi |
| public static final String EXTRA_TIME_USED = "android.app.usage.extra.TIME_USED"; |
| |
| @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023) |
| private static final UsageEvents sEmptyResults = new UsageEvents(); |
| |
| @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023) |
| private final Context mContext; |
| @UnsupportedAppUsage |
| private final IUsageStatsManager mService; |
| |
| /** |
| * {@hide} |
| */ |
| public UsageStatsManager(Context context, IUsageStatsManager service) { |
| mContext = context; |
| mService = service; |
| } |
| |
| /** |
| * Gets application usage stats for the given time range, aggregated by the specified interval. |
| * <p>The returned list will contain a {@link UsageStats} object for each package that |
| * has data for an interval that is a subset of the time range given. To illustrate:</p> |
| * <pre> |
| * 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 |
| * </pre> |
| * |
| * <p> The caller must have {@link android.Manifest.permission#PACKAGE_USAGE_STATS} </p> |
| * |
| * @param intervalType The time interval by which the stats are aggregated. |
| * @param beginTime The inclusive beginning of the range of stats to include in the results. |
| * @param endTime The exclusive end of the range of stats to include in the results. |
| * @return A list of {@link UsageStats} |
| * |
| * @see #INTERVAL_DAILY |
| * @see #INTERVAL_WEEKLY |
| * @see #INTERVAL_MONTHLY |
| * @see #INTERVAL_YEARLY |
| * @see #INTERVAL_BEST |
| */ |
| public List<UsageStats> queryUsageStats(int intervalType, long beginTime, long endTime) { |
| try { |
| @SuppressWarnings("unchecked") |
| ParceledListSlice<UsageStats> slice = mService.queryUsageStats(intervalType, beginTime, |
| endTime, mContext.getOpPackageName()); |
| if (slice != null) { |
| return slice.getList(); |
| } |
| } catch (RemoteException e) { |
| // fallthrough and return the empty list. |
| } |
| return Collections.emptyList(); |
| } |
| |
| /** |
| * Gets the hardware configurations the device was in for the given time range, aggregated by |
| * the specified interval. The results are ordered as in |
| * {@link #queryUsageStats(int, long, long)}. |
| * <p> The caller must have {@link android.Manifest.permission#PACKAGE_USAGE_STATS} </p> |
| * |
| * @param intervalType The time interval by which the stats are aggregated. |
| * @param beginTime The inclusive beginning of the range of stats to include in the results. |
| * @param endTime The exclusive end of the range of stats to include in the results. |
| * @return A list of {@link ConfigurationStats} |
| */ |
| public List<ConfigurationStats> queryConfigurations(int intervalType, long beginTime, |
| long endTime) { |
| try { |
| @SuppressWarnings("unchecked") |
| ParceledListSlice<ConfigurationStats> slice = mService.queryConfigurationStats( |
| intervalType, beginTime, endTime, mContext.getOpPackageName()); |
| if (slice != null) { |
| return slice.getList(); |
| } |
| } catch (RemoteException e) { |
| // fallthrough and return the empty list. |
| } |
| return Collections.emptyList(); |
| } |
| |
| /** |
| * Gets aggregated event stats for the given time range, aggregated by the specified interval. |
| * <p>The returned list will contain a {@link EventStats} object for each event type that |
| * is being aggregated and has data for an interval that is a subset of the time range given. |
| * |
| * <p>The current event types that will be aggregated here are:</p> |
| * <ul> |
| * <li>{@link UsageEvents.Event#SCREEN_INTERACTIVE}</li> |
| * <li>{@link UsageEvents.Event#SCREEN_NON_INTERACTIVE}</li> |
| * <li>{@link UsageEvents.Event#KEYGUARD_SHOWN}</li> |
| * <li>{@link UsageEvents.Event#KEYGUARD_HIDDEN}</li> |
| * </ul> |
| * |
| * <p> The caller must have {@link android.Manifest.permission#PACKAGE_USAGE_STATS} </p> |
| * |
| * @param intervalType The time interval by which the stats are aggregated. |
| * @param beginTime The inclusive beginning of the range of stats to include in the results. |
| * @param endTime The exclusive end of the range of stats to include in the results. |
| * @return A list of {@link EventStats} |
| * |
| * @see #INTERVAL_DAILY |
| * @see #INTERVAL_WEEKLY |
| * @see #INTERVAL_MONTHLY |
| * @see #INTERVAL_YEARLY |
| * @see #INTERVAL_BEST |
| */ |
| public List<EventStats> queryEventStats(int intervalType, long beginTime, long endTime) { |
| try { |
| @SuppressWarnings("unchecked") |
| ParceledListSlice<EventStats> slice = mService.queryEventStats(intervalType, beginTime, |
| endTime, mContext.getOpPackageName()); |
| if (slice != null) { |
| return slice.getList(); |
| } |
| } catch (RemoteException e) { |
| // fallthrough and return the empty list. |
| } |
| return Collections.emptyList(); |
| } |
| |
| /** |
| * Query for events in the given time range. Events are only kept by the system for a few |
| * days. |
| * <p> The caller must have {@link android.Manifest.permission#PACKAGE_USAGE_STATS} </p> |
| * |
| * @param beginTime The inclusive beginning of the range of events to include in the results. |
| * @param endTime The exclusive end of the range of events to include in the results. |
| * @return A {@link UsageEvents}. |
| */ |
| public UsageEvents queryEvents(long beginTime, long endTime) { |
| try { |
| UsageEvents iter = mService.queryEvents(beginTime, endTime, |
| mContext.getOpPackageName()); |
| if (iter != null) { |
| return iter; |
| } |
| } catch (RemoteException e) { |
| // fallthrough and return empty result. |
| } |
| return sEmptyResults; |
| } |
| |
| /** |
| * Like {@link #queryEvents(long, long)}, but only returns events for the calling package. |
| * |
| * @param beginTime The inclusive beginning of the range of events to include in the results. |
| * @param endTime The exclusive end of the range of events to include in the results. |
| * @return A {@link UsageEvents} object. |
| * |
| * @see #queryEvents(long, long) |
| */ |
| public UsageEvents queryEventsForSelf(long beginTime, long endTime) { |
| try { |
| final UsageEvents events = mService.queryEventsForPackage(beginTime, endTime, |
| mContext.getOpPackageName()); |
| if (events != null) { |
| return events; |
| } |
| } catch (RemoteException e) { |
| // fallthrough |
| } |
| return sEmptyResults; |
| } |
| |
| /** |
| * 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 {@link #queryUsageStats(int, long, long)}. |
| * <p> The caller must have {@link android.Manifest.permission#PACKAGE_USAGE_STATS} </p> |
| * |
| * @param beginTime The inclusive beginning of the range of stats to include in the results. |
| * @param endTime The exclusive end of the range of stats to include in the results. |
| * @return A {@link java.util.Map} keyed by package name |
| */ |
| public Map<String, UsageStats> queryAndAggregateUsageStats(long beginTime, long endTime) { |
| List<UsageStats> stats = queryUsageStats(INTERVAL_BEST, beginTime, endTime); |
| if (stats.isEmpty()) { |
| return Collections.emptyMap(); |
| } |
| |
| ArrayMap<String, UsageStats> aggregatedStats = new ArrayMap<>(); |
| final int statCount = stats.size(); |
| for (int i = 0; i < statCount; i++) { |
| UsageStats newStat = stats.get(i); |
| UsageStats existingStat = aggregatedStats.get(newStat.getPackageName()); |
| if (existingStat == null) { |
| aggregatedStats.put(newStat.mPackageName, newStat); |
| } else { |
| existingStat.add(newStat); |
| } |
| } |
| return aggregatedStats; |
| } |
| |
| /** |
| * 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. |
| * @param packageName The package name of the app to query |
| * @return whether the app is currently considered inactive |
| */ |
| public boolean isAppInactive(String packageName) { |
| try { |
| return mService.isAppInactive(packageName, mContext.getUserId()); |
| } catch (RemoteException e) { |
| // fall through and return default |
| } |
| return false; |
| } |
| |
| /** |
| * {@hide} |
| */ |
| public void setAppInactive(String packageName, boolean inactive) { |
| try { |
| mService.setAppInactive(packageName, inactive, mContext.getUserId()); |
| } catch (RemoteException e) { |
| // fall through |
| } |
| } |
| |
| /** |
| * Returns the current standby bucket of the calling app. The system determines the standby |
| * state of the app based on app usage patterns. Standby buckets determine how much an app will |
| * be restricted from running background tasks such as jobs and alarms. |
| * <p>Restrictions increase progressively from {@link #STANDBY_BUCKET_ACTIVE} to |
| * {@link #STANDBY_BUCKET_RARE}, with {@link #STANDBY_BUCKET_ACTIVE} being the least |
| * restrictive. The battery level of the device might also affect the restrictions. |
| * <p>Apps in buckets ≤ {@link #STANDBY_BUCKET_ACTIVE} have no standby restrictions imposed. |
| * Apps in buckets > {@link #STANDBY_BUCKET_FREQUENT} may have network access restricted when |
| * running in the background. |
| * <p>The standby state of an app can change at any time either due to a user interaction or a |
| * system interaction or some algorithm determining that the app can be restricted for a period |
| * of time before the user has a need for it. |
| * <p>You can also query the recent history of standby bucket changes by calling |
| * {@link #queryEventsForSelf(long, long)} and searching for |
| * {@link UsageEvents.Event#STANDBY_BUCKET_CHANGED}. |
| * |
| * @return the current standby bucket of the calling app. One of STANDBY_BUCKET_* constants. |
| */ |
| public @StandbyBuckets int getAppStandbyBucket() { |
| try { |
| return mService.getAppStandbyBucket(mContext.getOpPackageName(), |
| mContext.getOpPackageName(), |
| mContext.getUserId()); |
| } catch (RemoteException e) { |
| } |
| return STANDBY_BUCKET_ACTIVE; |
| } |
| |
| /** |
| * {@hide} |
| * Returns the current standby bucket of the specified app. The caller must hold the permission |
| * android.permission.PACKAGE_USAGE_STATS. |
| * @param packageName the package for which to fetch the current standby bucket. |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.PACKAGE_USAGE_STATS) |
| public @StandbyBuckets int getAppStandbyBucket(String packageName) { |
| try { |
| return mService.getAppStandbyBucket(packageName, mContext.getOpPackageName(), |
| mContext.getUserId()); |
| } catch (RemoteException e) { |
| } |
| return STANDBY_BUCKET_ACTIVE; |
| } |
| |
| /** |
| * {@hide} |
| * Changes an app's standby bucket to the provided value. The caller can only set the standby |
| * bucket for a different app than itself. |
| * @param packageName the package name of the app to set the bucket for. A SecurityException |
| * will be thrown if the package name is that of the caller. |
| * @param bucket the standby bucket to set it to, which should be one of STANDBY_BUCKET_*. |
| * Setting a standby bucket outside of the range of STANDBY_BUCKET_ACTIVE to |
| * STANDBY_BUCKET_NEVER will result in a SecurityException. |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.CHANGE_APP_IDLE_STATE) |
| public void setAppStandbyBucket(String packageName, @StandbyBuckets int bucket) { |
| try { |
| mService.setAppStandbyBucket(packageName, bucket, mContext.getUserId()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| /** |
| * {@hide} |
| * Returns the current standby bucket of every app that has a bucket assigned to it. |
| * The caller must hold the permission android.permission.PACKAGE_USAGE_STATS. The key of the |
| * returned Map is the package name and the value is the bucket assigned to the package. |
| * @see #getAppStandbyBucket() |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.PACKAGE_USAGE_STATS) |
| public Map<String, Integer> getAppStandbyBuckets() { |
| try { |
| final ParceledListSlice<AppStandbyInfo> slice = mService.getAppStandbyBuckets( |
| mContext.getOpPackageName(), mContext.getUserId()); |
| final List<AppStandbyInfo> bucketList = slice.getList(); |
| final ArrayMap<String, Integer> bucketMap = new ArrayMap<>(); |
| final int n = bucketList.size(); |
| for (int i = 0; i < n; i++) { |
| final AppStandbyInfo bucketInfo = bucketList.get(i); |
| bucketMap.put(bucketInfo.mPackageName, bucketInfo.mStandbyBucket); |
| } |
| return bucketMap; |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| /** |
| * {@hide} |
| * Changes the app standby bucket for multiple apps at once. The Map is keyed by the package |
| * name and the value is one of STANDBY_BUCKET_*. |
| * @param appBuckets a map of package name to bucket value. |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.CHANGE_APP_IDLE_STATE) |
| public void setAppStandbyBuckets(Map<String, Integer> appBuckets) { |
| if (appBuckets == null) { |
| return; |
| } |
| final List<AppStandbyInfo> bucketInfoList = new ArrayList<>(appBuckets.size()); |
| for (Map.Entry<String, Integer> bucketEntry : appBuckets.entrySet()) { |
| bucketInfoList.add(new AppStandbyInfo(bucketEntry.getKey(), bucketEntry.getValue())); |
| } |
| final ParceledListSlice<AppStandbyInfo> slice = new ParceledListSlice<>(bucketInfoList); |
| try { |
| mService.setAppStandbyBuckets(slice, mContext.getUserId()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| /** |
| * @hide |
| * Register an app usage limit observer that receives a callback on the provided intent when |
| * the sum of usages of apps in the packages array exceeds the {@code timeLimit} specified. The |
| * observer will automatically be unregistered when the time limit is reached and the intent |
| * is delivered. Registering an {@code observerId} that was already registered will override |
| * the previous one. No more than 1000 unique {@code observerId} may be registered by a single |
| * uid at any one time. |
| * @param observerId A unique id associated with the group of apps to be monitored. There can |
| * be multiple groups with common packages and different time limits. |
| * @param packages The list of packages to observe for foreground activity time. Cannot be null |
| * and must include at least one package. |
| * @param timeLimit The total time the set of apps can be in the foreground before the |
| * callbackIntent is delivered. Must be at least one minute. |
| * @param timeUnit The unit for time specified in {@code timeLimit}. Cannot be null. |
| * @param callbackIntent The PendingIntent that will be dispatched when the time limit is |
| * exceeded by the group of apps. The delivered Intent will also contain |
| * the extras {@link #EXTRA_OBSERVER_ID}, {@link #EXTRA_TIME_LIMIT} and |
| * {@link #EXTRA_TIME_USED}. Cannot be null. |
| * @throws SecurityException if the caller doesn't have the OBSERVE_APP_USAGE permission or |
| * is not the profile owner of this user. |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.OBSERVE_APP_USAGE) |
| public void registerAppUsageObserver(int observerId, @NonNull String[] packages, long timeLimit, |
| @NonNull TimeUnit timeUnit, @NonNull PendingIntent callbackIntent) { |
| try { |
| mService.registerAppUsageObserver(observerId, packages, timeUnit.toMillis(timeLimit), |
| callbackIntent, mContext.getOpPackageName()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| /** |
| * @hide |
| * Unregister the app usage observer specified by the {@code observerId}. This will only apply |
| * to any observer registered by this application. Unregistering an observer that was already |
| * unregistered or never registered will have no effect. |
| * @param observerId The id of the observer that was previously registered. |
| * @throws SecurityException if the caller doesn't have the OBSERVE_APP_USAGE permission or is |
| * not the profile owner of this user. |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.OBSERVE_APP_USAGE) |
| public void unregisterAppUsageObserver(int observerId) { |
| try { |
| mService.unregisterAppUsageObserver(observerId, mContext.getOpPackageName()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| /** @hide */ |
| public static String reasonToString(int standbyReason) { |
| StringBuilder sb = new StringBuilder(); |
| switch (standbyReason & REASON_MAIN_MASK) { |
| case REASON_MAIN_DEFAULT: |
| sb.append("d"); |
| break; |
| case REASON_MAIN_FORCED: |
| sb.append("f"); |
| break; |
| case REASON_MAIN_PREDICTED: |
| sb.append("p"); |
| switch (standbyReason & REASON_SUB_MASK) { |
| case REASON_SUB_PREDICTED_RESTORED: |
| sb.append("-r"); |
| break; |
| } |
| break; |
| case REASON_MAIN_TIMEOUT: |
| sb.append("t"); |
| break; |
| case REASON_MAIN_USAGE: |
| sb.append("u"); |
| switch (standbyReason & REASON_SUB_MASK) { |
| case REASON_SUB_USAGE_SYSTEM_INTERACTION: |
| sb.append("-si"); |
| break; |
| case REASON_SUB_USAGE_NOTIFICATION_SEEN: |
| sb.append("-ns"); |
| break; |
| case REASON_SUB_USAGE_USER_INTERACTION: |
| sb.append("-ui"); |
| break; |
| case REASON_SUB_USAGE_MOVE_TO_FOREGROUND: |
| sb.append("-mf"); |
| break; |
| case REASON_SUB_USAGE_MOVE_TO_BACKGROUND: |
| sb.append("-mb"); |
| break; |
| case REASON_SUB_USAGE_SYSTEM_UPDATE: |
| sb.append("-su"); |
| break; |
| case REASON_SUB_USAGE_ACTIVE_TIMEOUT: |
| sb.append("-at"); |
| break; |
| case REASON_SUB_USAGE_SYNC_ADAPTER: |
| sb.append("-sa"); |
| break; |
| case REASON_SUB_USAGE_SLICE_PINNED: |
| sb.append("-lp"); |
| break; |
| case REASON_SUB_USAGE_SLICE_PINNED_PRIV: |
| sb.append("-lv"); |
| break; |
| case REASON_SUB_USAGE_EXEMPTED_SYNC_SCHEDULED_NON_DOZE: |
| sb.append("-en"); |
| break; |
| case REASON_SUB_USAGE_EXEMPTED_SYNC_SCHEDULED_DOZE: |
| sb.append("-ed"); |
| break; |
| case REASON_SUB_USAGE_EXEMPTED_SYNC_START: |
| sb.append("-es"); |
| break; |
| } |
| break; |
| } |
| return sb.toString(); |
| } |
| |
| /** |
| * {@hide} |
| * Temporarily whitelist the specified app for a short duration. This is to allow an app |
| * receiving a high priority message to be able to access the network and acquire wakelocks |
| * even if the device is in power-save mode or the app is currently considered inactive. |
| * @param packageName The package name of the app to whitelist. |
| * @param duration Duration to whitelist the app for, in milliseconds. It is recommended that |
| * this be limited to 10s of seconds. Requested duration will be clamped to a few minutes. |
| * @param user The user for whom the package should be whitelisted. Passing in a user that is |
| * not the same as the caller's process will require the INTERACT_ACROSS_USERS permission. |
| * @see #isAppInactive(String) |
| */ |
| @SystemApi |
| @RequiresPermission(android.Manifest.permission.CHANGE_DEVICE_IDLE_TEMP_WHITELIST) |
| public void whitelistAppTemporarily(String packageName, long duration, UserHandle user) { |
| try { |
| mService.whitelistAppTemporarily(packageName, duration, user.getIdentifier()); |
| } catch (RemoteException re) { |
| throw re.rethrowFromSystemServer(); |
| } |
| } |
| |
| /** |
| * Inform usage stats that the carrier privileged apps access rules have changed. |
| * @hide |
| */ |
| public void onCarrierPrivilegedAppsChanged() { |
| try { |
| mService.onCarrierPrivilegedAppsChanged(); |
| } catch (RemoteException re) { |
| throw re.rethrowFromSystemServer(); |
| } |
| } |
| |
| /** |
| * Reports a Chooser action to the UsageStatsManager. |
| * |
| * @param packageName The package name of the app that is selected. |
| * @param userId The user id of who makes the selection. |
| * @param contentType The type of the content, e.g., Image, Video, App. |
| * @param annotations The annotations of the content, e.g., Game, Selfie. |
| * @param action The action type of Intent that invokes ChooserActivity. |
| * {@link UsageEvents} |
| * @hide |
| */ |
| public void reportChooserSelection(String packageName, int userId, String contentType, |
| String[] annotations, String action) { |
| try { |
| mService.reportChooserSelection(packageName, userId, contentType, annotations, action); |
| } catch (RemoteException re) { |
| } |
| } |
| } |