com.mapbox.mapboxsdk.location

Class LocationSource

java.lang.Object

com.mapbox.services.android.telemetry.location.LocationEngine

com.mapbox.mapboxsdk.location.LocationSource

All Implemented Interfaces:

com.mapzen.android.lost.api.LocationListener

public class LocationSource
extends com.mapbox.services.android.telemetry.location.LocationEngine
implements com.mapzen.android.lost.api.LocationListener

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

• You can register a LocationEngineListener with LocationSource#addLocationEngineListener(LocationEngineListener) to receive location updates.
• You can unregister a LocationEngineListener with LocationEngine#removeLocationEngineListener(LocationEngineListener)} to stop receiving location updates.

Note: If registering a listener in your Activity.onStart() implementation, you should unregister it in Activity.onStop(). (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.

Field Summary

Fields inherited from class com.mapbox.services.android.telemetry.location.LocationEngine

fastestInterval, interval, locationListeners, priority, smallestDisplacement

Constructor Summary

Constructors

Constructor and Description
LocationSource(Context context) Constructs a location source instance.

Method Summary

Modifier and Type	Method and Description
void	activate() Activate the location engine which will connect whichever location provider you are using.
void	deactivate() Disconnect the location engine which is useful when you no longer need location updates or requesting the users LocationEngine.getLastLocation().
Location	getLastLocation() Returns the Last known location is the location provider is connected and location permissions are granted.
boolean	isConnected() Check if your location provider has been activated/connected.
void	onLocationChanged(Location location) Invoked when the Location has changed.
void	removeLocationUpdates() Dismiss ongoing location update to the location provider.
void	requestLocationUpdates() Request location updates to the location provider.

Methods inherited from class com.mapbox.services.android.telemetry.location.LocationEngine

addLocationEngineListener, getFastestInterval, getInterval, getPriority, getSmallestDisplacement, isBetterLocation, removeLocationEngineListener, setFastestInterval, setInterval, setPriority, setSmallestDisplacement

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationSource

public LocationSource(Context context)

Constructs a location source instance.

Parameters:

context - the context from which the Application context will be derived.

Method Detail

activate

public void activate()

Activate the location engine which will connect whichever location provider you are using. You'll need to call this before requesting user location updates using LocationEngine.requestLocationUpdates().

Specified by:

activate in class com.mapbox.services.android.telemetry.location.LocationEngine

deactivate

public void deactivate()

Disconnect the location engine which is useful when you no longer need location updates or requesting the users LocationEngine.getLastLocation(). Before deactivating, you'll need to stop request user location updates using LocationEngine.removeLocationUpdates().

Specified by:

deactivate in class com.mapbox.services.android.telemetry.location.LocationEngine

isConnected

public boolean isConnected()

Check if your location provider has been activated/connected. This is mainly used internally but is also useful in the rare case when you'd like to know if your location engine is connected or not.

Specified by:

isConnected in class com.mapbox.services.android.telemetry.location.LocationEngine

Returns:

boolean true if the location engine has been activated/connected, else false.

getLastLocation

@Nullable
public Location getLastLocation()

Returns the Last known location is the location provider is connected and location permissions are granted.

Specified by:

getLastLocation in class com.mapbox.services.android.telemetry.location.LocationEngine

Returns:

the last known location

requestLocationUpdates

public void requestLocationUpdates()

Request location updates to the location provider.

Specified by:

requestLocationUpdates in class com.mapbox.services.android.telemetry.location.LocationEngine

removeLocationUpdates

public void removeLocationUpdates()

Dismiss ongoing location update to the location provider.

Specified by:

removeLocationUpdates in class com.mapbox.services.android.telemetry.location.LocationEngine

onLocationChanged

public void onLocationChanged(Location location)

Invoked when the Location has changed.

Specified by:

onLocationChanged in interface com.mapzen.android.lost.api.LocationListener

Parameters:

location - the new location