[android] #4748 - add javadoc for unregistering location listeners

This commit is contained in:
Tobrun
2016-05-06 14:31:17 +02:00
parent def05ab5f8
commit 1ade5e3aa6

View File

@@ -9,13 +9,26 @@ import android.location.LocationManager;
import android.support.annotation.NonNull;
import android.support.v4.content.ContextCompat;
import android.util.Log;
import com.mapbox.mapboxsdk.telemetry.TelemetryLocationReceiver;
import com.mapzen.android.lost.api.LocationRequest;
import com.mapzen.android.lost.api.LostApiClient;
import java.util.concurrent.CopyOnWriteArrayList;
/**
* Manages locational updates. Contains methods to register and unregister location listeners.
* <p>
* <ul>
* <li>You can register a {@link LocationListener} with {@link #addLocationListener(LocationListener)} to receive location updates.</li>
* <li> You can unregister a {@link LocationListener} with {@link #removeLocationListener(LocationListener)}.</li>
* </ul>
* <p/>
* <p>
* Note: If registering a listener in your Activity.onResume() implementation, you should unregister it in Activity.onPause().
* (You won't receive location updates when paused, and this will cut down on unnecessary system overhead).
* Do not unregister in Activity.onSaveInstanceState(), because this won't be called if the user moves back in the history stack.
* </p>
*/
public class LocationServices implements com.mapzen.android.lost.api.LocationListener {