Documented return value of getRestrictBackgroundStatus().

Change-Id: I2c15a6d5e23cbc3c9b59c975196c1c04c1294471 Fixes: 28775490
2016-05-16 13:57:19 -07:00
parent 942ee1159f
commit 6bd46fc303
1 changed files with 4 additions and 0 deletions
--- a/core/java/android/net/ConnectivityManager.java
+++ b/core/java/android/net/ConnectivityManager.java
@@ -3362,6 +3362,10 @@ public class ConnectivityManager {
    /**
     * Determines if the calling application is subject to metered network restrictions while
     * running on background.
+     *
+     * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
+     * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
+     * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
     */
    public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
        try {