Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 64baddcb authored by Michael Groover's avatar Michael Groover Committed by Automerger Merge Worker
Browse files

Merge "Update docs for methods that require subscriberId" into rvc-dev am: 2bcb7032 

Original change: https://googleplex-android-review.googlesource.com/c/platform/frameworks/base/+/11932150

Change-Id: I310f0ac101c670b251a3cbf07408d3d7033d72c5
parents ddd636ce 2bcb7032

core/java/android/app/usage/NetworkStatsManager.java

+40 −3
Original line number Original line Diff line number Diff line
@@ -41,6 +41,7 @@ import android.os.Messenger; 
import android.os.RemoteException;

import android.os.RemoteException;

import android.os.ServiceManager;

import android.os.ServiceManager;

import android.os.ServiceManager.ServiceNotFoundException;

import android.os.ServiceManager.ServiceNotFoundException;

import android.telephony.TelephonyManager;

import android.util.DataUnit;

import android.util.DataUnit;

import android.util.Log;

import android.util.Log;
@@ -198,6 +199,12 @@ public class NetworkStatsManager { 
     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            etc.

     *            etc.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     *                     <p>Starting with API level 29, the {@code subscriberId} is guarded by

     *                     additional restrictions. Calling apps that do not meet the new

     *                     requirements to access the {@code subscriberId} can provide a {@code

     *                     null} value when querying for the mobile network type to receive usage

     *                     for all mobile networks. For additional details see {@link

     *                     TelephonyManager#getSubscriberId()}.

     * @param startTime Start of period. Defined in terms of "Unix time", see

     * @param startTime Start of period. Defined in terms of "Unix time", see

     *            {@link java.lang.System#currentTimeMillis}.

     *            {@link java.lang.System#currentTimeMillis}.

     * @param endTime End of period. Defined in terms of "Unix time", see

     * @param endTime End of period. Defined in terms of "Unix time", see
@@ -231,6 +238,12 @@ public class NetworkStatsManager { 
     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            etc.

     *            etc.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     *                     <p>Starting with API level 29, the {@code subscriberId} is guarded by

     *                     additional restrictions. Calling apps that do not meet the new

     *                     requirements to access the {@code subscriberId} can provide a {@code

     *                     null} value when querying for the mobile network type to receive usage

     *                     for all mobile networks. For additional details see {@link

     *                     TelephonyManager#getSubscriberId()}.

     * @param startTime Start of period. Defined in terms of "Unix time", see

     * @param startTime Start of period. Defined in terms of "Unix time", see

     *            {@link java.lang.System#currentTimeMillis}.

     *            {@link java.lang.System#currentTimeMillis}.

     * @param endTime End of period. Defined in terms of "Unix time", see

     * @param endTime End of period. Defined in terms of "Unix time", see
@@ -268,6 +281,12 @@ public class NetworkStatsManager { 
     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            etc.

     *            etc.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     *                     <p>Starting with API level 29, the {@code subscriberId} is guarded by

     *                     additional restrictions. Calling apps that do not meet the new

     *                     requirements to access the {@code subscriberId} can provide a {@code

     *                     null} value when querying for the mobile network type to receive usage

     *                     for all mobile networks. For additional details see {@link

     *                     TelephonyManager#getSubscriberId()}.

     * @param startTime Start of period. Defined in terms of "Unix time", see

     * @param startTime Start of period. Defined in terms of "Unix time", see

     *            {@link java.lang.System#currentTimeMillis}.

     *            {@link java.lang.System#currentTimeMillis}.

     * @param endTime End of period. Defined in terms of "Unix time", see

     * @param endTime End of period. Defined in terms of "Unix time", see
@@ -301,7 +320,7 @@ public class NetworkStatsManager { 
    /**

    /**

     * Query network usage statistics details for a given uid.

     * Query network usage statistics details for a given uid.

     *

     *

     * #see queryDetailsForUidTagState(int, String, long, long, int, int, int)

     * @see #queryDetailsForUidTagState(int, String, long, long, int, int, int)

     */

     */

    public NetworkStats queryDetailsForUid(int networkType, String subscriberId,

    public NetworkStats queryDetailsForUid(int networkType, String subscriberId,

            long startTime, long endTime, int uid) throws SecurityException {

            long startTime, long endTime, int uid) throws SecurityException {
@@ -319,7 +338,7 @@ public class NetworkStatsManager { 
    /**

    /**

     * Query network usage statistics details for a given uid and tag.

     * Query network usage statistics details for a given uid and tag.

     *

     *

     * #see queryDetailsForUidTagState(int, String, long, long, int, int, int)

     * @see #queryDetailsForUidTagState(int, String, long, long, int, int, int)

     */

     */

    public NetworkStats queryDetailsForUidTag(int networkType, String subscriberId,

    public NetworkStats queryDetailsForUidTag(int networkType, String subscriberId,

            long startTime, long endTime, int uid, int tag) throws SecurityException {

            long startTime, long endTime, int uid, int tag) throws SecurityException {
@@ -344,6 +363,12 @@ public class NetworkStatsManager { 
     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            etc.

     *            etc.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     *                     <p>Starting with API level 29, the {@code subscriberId} is guarded by

     *                     additional restrictions. Calling apps that do not meet the new

     *                     requirements to access the {@code subscriberId} can provide a {@code

     *                     null} value when querying for the mobile network type to receive usage

     *                     for all mobile networks. For additional details see {@link

     *                     TelephonyManager#getSubscriberId()}.

     * @param startTime Start of period. Defined in terms of "Unix time", see

     * @param startTime Start of period. Defined in terms of "Unix time", see

     *            {@link java.lang.System#currentTimeMillis}.

     *            {@link java.lang.System#currentTimeMillis}.

     * @param endTime End of period. Defined in terms of "Unix time", see

     * @param endTime End of period. Defined in terms of "Unix time", see
@@ -398,6 +423,12 @@ public class NetworkStatsManager { 
     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}

     *            etc.

     *            etc.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     *                     <p>Starting with API level 29, the {@code subscriberId} is guarded by

     *                     additional restrictions. Calling apps that do not meet the new

     *                     requirements to access the {@code subscriberId} can provide a {@code

     *                     null} value when querying for the mobile network type to receive usage

     *                     for all mobile networks. For additional details see {@link

     *                     TelephonyManager#getSubscriberId()}.

     * @param startTime Start of period. Defined in terms of "Unix time", see

     * @param startTime Start of period. Defined in terms of "Unix time", see

     *            {@link java.lang.System#currentTimeMillis}.

     *            {@link java.lang.System#currentTimeMillis}.

     * @param endTime End of period. Defined in terms of "Unix time", see

     * @param endTime End of period. Defined in terms of "Unix time", see
@@ -455,7 +486,7 @@ public class NetworkStatsManager { 
    /**

    /**

     * Registers to receive notifications about data usage on specified networks.

     * Registers to receive notifications about data usage on specified networks.

     *

     *

     * #see registerUsageCallback(int, String[], long, UsageCallback, Handler)

     * @see #registerUsageCallback(int, String, long, UsageCallback, Handler)

     */

     */

    public void registerUsageCallback(int networkType, String subscriberId, long thresholdBytes,

    public void registerUsageCallback(int networkType, String subscriberId, long thresholdBytes,

            UsageCallback callback) {

            UsageCallback callback) {
@@ -472,6 +503,12 @@ public class NetworkStatsManager { 
     * @param networkType Type of network to monitor. Either

     * @param networkType Type of network to monitor. Either

                  {@link ConnectivityManager#TYPE_MOBILE} or {@link ConnectivityManager#TYPE_WIFI}.

                  {@link ConnectivityManager#TYPE_MOBILE} or {@link ConnectivityManager#TYPE_WIFI}.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     * @param subscriberId If applicable, the subscriber id of the network interface.

     *                     <p>Starting with API level 29, the {@code subscriberId} is guarded by

     *                     additional restrictions. Calling apps that do not meet the new

     *                     requirements to access the {@code subscriberId} can provide a {@code

     *                     null} value when registering for the mobile network type to receive

     *                     notifications for all mobile networks. For additional details see {@link

     *                     TelephonyManager#getSubscriberId()}.

     * @param thresholdBytes Threshold in bytes to be notified on.

     * @param thresholdBytes Threshold in bytes to be notified on.

     * @param callback The {@link UsageCallback} that the system will call when data usage

     * @param callback The {@link UsageCallback} that the system will call when data usage

     *            has exceeded the specified threshold.

     *            has exceeded the specified threshold.