com.mapbox.services.android.location

Class LostLocationEngine

java.lang.Object

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

com.mapbox.services.android.location.LostLocationEngine

All Implemented Interfaces:

com.mapzen.android.lost.api.LocationListener, com.mapzen.android.lost.api.LostApiClient.ConnectionCallbacks

public class LostLocationEngine
extends com.mapbox.services.android.telemetry.location.LocationEngine
implements com.mapzen.android.lost.api.LostApiClient.ConnectionCallbacks, com.mapzen.android.lost.api.LocationListener

Sample LocationEngine using the Open Source Lost library

Nested Class Summary

Nested classes/interfaces inherited from class com.mapbox.services.android.telemetry.location.LocationEngine

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

Field Summary

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

fastestInterval, interval, locationListeners, priority, smallestDisplacement

Constructor Summary

Constructors

Constructor and Description
LostLocationEngine(android.content.Context context)

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().
android.location.Location	getLastLocation() Returns the Last known location if the location provider is connected and location permissions are granted.
static com.mapbox.services.android.telemetry.location.LocationEngine	getLocationEngine(android.content.Context context)
boolean	isConnected() Check if your location provider has been activated/connected.
com.mapbox.services.android.telemetry.location.LocationEngine.Type	obtainType()
void	onConnected() Invoked when the location provider has connected.
void	onConnectionSuspended() Invoked when the location provider connection has been suspended.
void	onLocationChanged(android.location.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

LostLocationEngine

public LostLocationEngine(android.content.Context context)

Method Detail

getLocationEngine

public static com.mapbox.services.android.telemetry.location.LocationEngine getLocationEngine(android.content.Context context)

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.

onConnected

public void onConnected()

Invoked when the location provider has connected.

Specified by:

onConnected in interface com.mapzen.android.lost.api.LostApiClient.ConnectionCallbacks

onConnectionSuspended

public void onConnectionSuspended()

Invoked when the location provider connection has been suspended.

Specified by:

onConnectionSuspended in interface com.mapzen.android.lost.api.LostApiClient.ConnectionCallbacks

getLastLocation

@Nullable
public android.location.Location getLastLocation()

Returns the Last known location if 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

obtainType

public com.mapbox.services.android.telemetry.location.LocationEngine.Type obtainType()

Specified by:

obtainType 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(android.location.Location location)

Invoked when the Location has changed.

Specified by:

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

Parameters:

location - the new location