diff options
author | Scott Main <smain@google.com> | 2012-10-29 19:11:41 -0700 |
---|---|---|
committer | Android (Google) Code Review <android-gerrit@google.com> | 2012-11-01 09:54:15 -0700 |
commit | 8761e143c987fc48d854818988cde44700c9f602 (patch) | |
tree | 1fb5e1274405e5576d1a72776cba03892b4b1964 /location | |
parent | c86e8dffd04804f7f975c80325bc3ae70e7e972a (diff) | |
download | frameworks_base-8761e143c987fc48d854818988cde44700c9f602.zip frameworks_base-8761e143c987fc48d854818988cde44700c9f602.tar.gz frameworks_base-8761e143c987fc48d854818988cde44700c9f602.tar.bz2 |
docs: Clarify the callback mechanisms for LocationRequest
and clarify horizontal geofencing
Change-Id: I8ff264d7a12c8ec3c79854e008aeeb5f922ad459
Diffstat (limited to 'location')
-rw-r--r-- | location/java/android/location/Geofence.java | 4 | ||||
-rw-r--r-- | location/java/android/location/LocationManager.java | 8 |
2 files changed, 10 insertions, 2 deletions
diff --git a/location/java/android/location/Geofence.java b/location/java/android/location/Geofence.java index b3e4a88..791d3d0 100644 --- a/location/java/android/location/Geofence.java +++ b/location/java/android/location/Geofence.java @@ -22,7 +22,7 @@ import android.os.Parcelable; /** * Represents a geographical boundary, also known as a geofence. * - * <p>Currently only circular geofences are supported. + * <p>Currently only circular geofences are supported and they do not support altitude changes. */ public final class Geofence implements Parcelable { /** @hide */ @@ -34,7 +34,7 @@ public final class Geofence implements Parcelable { private final float mRadius; /** - * Create a horizontal, circular geofence. + * Create a circular geofence (on a flat, horizontal plane). * * @param latitude latitude in degrees * @param longitude longitude in degrees diff --git a/location/java/android/location/LocationManager.java b/location/java/android/location/LocationManager.java index 59a5624..653e8d1 100644 --- a/location/java/android/location/LocationManager.java +++ b/location/java/android/location/LocationManager.java @@ -811,6 +811,10 @@ public class LocationManager { /** * Register for fused location updates using a LocationRequest and callback. * + * <p>Upon a location update, the system delivers the new {@link Location} to the + * provided {@link LocationListener}, by calling its {@link + * LocationListener#onLocationChanged} method.</p> + * * <p>The system will automatically select and enable the best providers * to compute a location for your application. It may use only passive * locations, or just a single location source, or it may fuse together @@ -869,6 +873,10 @@ public class LocationManager { /** * Register for fused location updates using a LocationRequest and a pending intent. * + * <p>Upon a location update, the system delivers the new {@link Location} with your provided + * {@link PendingIntent}, as the value for {@link LocationManager#KEY_LOCATION_CHANGED} + * in the intent's extras.</p> + * * <p> To unregister for Location updates, use: {@link #removeUpdates(PendingIntent)}. * * <p> See {@link #requestLocationUpdates(LocationRequest, LocationListener, Looper)} |