diff options
author | David Christie <dnchrist@google.com> | 2013-08-16 16:16:27 -0700 |
---|---|---|
committer | David Christie <dnchrist@google.com> | 2013-08-16 16:16:27 -0700 |
commit | 3e32bdd41832d383b03f928cfd2341b9693dc78b (patch) | |
tree | 67903b97c875c8b76d5a5cac34f3dfd764eab5db /location | |
parent | d0d554579b244d8d98e63e866be19333a8aa8b2e (diff) | |
download | frameworks_base-3e32bdd41832d383b03f928cfd2341b9693dc78b.zip frameworks_base-3e32bdd41832d383b03f928cfd2341b9693dc78b.tar.gz frameworks_base-3e32bdd41832d383b03f928cfd2341b9693dc78b.tar.bz2 |
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
Diffstat (limited to 'location')
-rw-r--r-- | location/java/android/location/LocationRequest.java | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/location/java/android/location/LocationRequest.java b/location/java/android/location/LocationRequest.java index 507baeb..c9162fe 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. + * + * <p>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. + * + * <p>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. + * + * <p>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; } |