com.mapbox.mapboxsdk.location

Class LocationServices

java.lang.Object

com.mapbox.mapboxsdk.location.LocationServices

public class LocationServices
extends java.lang.Object

Manages locational updates. Contains methods to register and unregister location listeners.

• You can register a LocationListener with addLocationListener(LocationListener) to receive location updates.
• You can unregister a LocationListener with removeLocationListener(LocationListener).

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.

Method Summary

Modifier and Type	Method and Description
void	addLocationListener(LocationListener locationListener) Registers a LocationListener to receive location updates
boolean	areLocationPermissionsGranted() Check status of Location Permissions
android.location.Location	getLastLocation() Last known location
static LocationServices	getLocationServices(android.content.Context context) Primary (singleton) access method for LocationServices
boolean	isGPSEnabled() Returns if the GPS sensor is currently enabled
void	onLocationChanged(android.location.Location location) Called when the location has changed.
boolean	removeLocationListener(LocationListener locationListener) Unregister a LocationListener to stop receiving location updates
void	toggleGPS(boolean enableGPS) Enabled / Disable GPS focused location tracking

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLocationServices

public static LocationServices getLocationServices(android.content.Context context)

Primary (singleton) access method for LocationServices

Parameters:

context - Context

Returns:

LocationServices

toggleGPS

public void toggleGPS(boolean enableGPS)

Enabled / Disable GPS focused location tracking

Parameters:

enableGPS - true if GPS is to be enabled, false if GPS is to be disabled

isGPSEnabled

public boolean isGPSEnabled()

Returns if the GPS sensor is currently enabled

Returns:

active state of the GPS

onLocationChanged

public void onLocationChanged(android.location.Location location)

Called when the location has changed.

Parameters:

location - The updated location

getLastLocation

public android.location.Location getLastLocation()

Last known location

Returns:

Last known location data

addLocationListener

public void addLocationListener(LocationListener locationListener)

Registers a LocationListener to receive location updates

Parameters:

locationListener - LocationListener

removeLocationListener

public boolean removeLocationListener(LocationListener locationListener)

Unregister a LocationListener to stop receiving location updates

Parameters:

locationListener - LocationListener to remove

Returns:

True if LocationListener was found and removed, False if it was not

areLocationPermissionsGranted

public boolean areLocationPermissionsGranted()

Check status of Location Permissions

Returns:

True if granted to the app, False if not