From 3e32bdd41832d383b03f928cfd2341b9693dc78b Mon Sep 17 00:00:00 2001 From: David Christie Date: Fri, 16 Aug 2013 16:16:27 -0700 Subject: [PATCH] Add comments to new hidden API in LocationRequest. Document their purpose and permissions required in case this is unhidden in a different code line. Change-Id: I42f6f950157f488cf51b361e3411861ff98794e8 --- .../java/android/location/LocationRequest.java | 26 ++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/location/java/android/location/LocationRequest.java b/location/java/android/location/LocationRequest.java index 507baeb76f81..c9162fe1892f 100644 --- a/location/java/android/location/LocationRequest.java +++ b/location/java/android/location/LocationRequest.java @@ -498,7 +498,16 @@ public final class LocationRequest implements Parcelable { return mSmallestDisplacement; } - /** @hide */ + /** + * Sets the WorkSource to use for power blaming of this location request. + * + *

No permissions are required to make this call, however the LocationManager + * will throw a SecurityException when requesting location updates if the caller + * doesn't have the {@link android.Manifest.permission#UPDATE_DEVICE_STATS} permission. + * + * @param workSource WorkSource defining power blame for this location request. + * @hide + */ public void setWorkSource(WorkSource workSource) { mWorkSource = workSource; } @@ -508,7 +517,20 @@ public final class LocationRequest implements Parcelable { return mWorkSource; } - /** @hide */ + /** + * Sets whether or not this location request should be hidden from AppOps. + * + *

Hiding a location request from AppOps will remove user visibility in the UI as to this + * request's existence. It does not affect power blaming in the Battery page. + * + *

No permissions are required to make this call, however the LocationManager + * will throw a SecurityException when requesting location updates if the caller + * doesn't have the {@link android.Manifest.permission#UPDATE_APP_OPS_STATS} permission. + * + * @param hideFromAppOps If true AppOps won't keep track of this location request. + * @see android.app.AppOpsManager + * @hide + */ public void setHideFromAppOps(boolean hideFromAppOps) { mHideFromAppOps = hideFromAppOps; } -- 2.11.0