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

Commit 7d6333e8 authored by Soonil Nagarkar's avatar Soonil Nagarkar
Browse files

Clarifying documentation on removeUpdates and flushing 

Document how batch flushes interact with removing updates.

Test: n/a
Change-Id: Ie65f517a7bda6273739f9c59df18e290fd0d770a
parent 1681b437

location/java/android/location/LocationManager.java

+11 −2
Original line number Diff line number Diff line
@@ -1509,8 +1509,15 @@ public class LocationManager { 
    }



    /**

     * Removes location updates for the specified {@link LocationListener}. Following this call,

     * the listener will not receive any more invocations of any kind.

     * Removes all location updates for the specified {@link LocationListener}. The given listener

     * is guaranteed not to receive any invocations that <b>happens-after</b> this method is

     * invoked.

     *

     * <p>If the given listener has any batched requests, this method will not flush any incomplete

     * location batches before stopping location updates. If you wish to flush any pending locations

     * before stopping, you must first call {@link #requestFlush(String, LocationListener, int)} and

     * then call this method once the flush is complete. If this method is invoked before the flush

     * is complete, you may not receive the flushed locations.

     *

     * @param listener listener that no longer needs location updates

     *
@@ -1537,6 +1544,8 @@ public class LocationManager { 
     * Removes location updates for the specified {@link PendingIntent}. Following this call, the

     * PendingIntent will no longer receive location updates.

     *

     * <p>See {@link #removeUpdates(LocationListener)} for more detail on how this method works.

     *

     * @param pendingIntent pending intent that no longer needs location updates

     *

     * @throws IllegalArgumentException if pendingIntent is null