com.mapbox.services.android.telemetry.location

Class AndroidLocationEngine

java.lang.Object

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

com.mapbox.services.android.telemetry.location.AndroidLocationEngine

All Implemented Interfaces:

android.location.LocationListener

public class AndroidLocationEngine
extends LocationEngine
implements android.location.LocationListener

A location engine that uses core android.location and has no external dependencies https://developer.android.com/guide/topics/location/strategies.html

Nested Class Summary

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

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
AndroidLocationEngine(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, useful when you no longer need location updates or requesting the users LocationEngine.getLastLocation().
android.location.Location	getLastLocation() When first initializing the location engine the location updates oftentimes aren't immediate and your user experience might diminish since they are forced to wait till a more accurate update arrives.
static LocationEngine	getLocationEngine(android.content.Context context)
boolean	isConnected() Check if your location provider has been activated/connected.
LocationEngine.Type	obtainType() Get the current LocationEngine LocationEngine.Type being used.
void	onLocationChanged(android.location.Location location) Called when the location has changed.
void	onProviderDisabled(java.lang.String provider) Called when the provider is disabled by the user.
void	onProviderEnabled(java.lang.String provider) Called when the provider is enabled by the user.
void	onStatusChanged(java.lang.String provider, int status, android.os.Bundle extras) Called when the provider status changes.
void	removeLocationUpdates() When you no longer wish to receive location updates, you should call this method to prevent the devices battery from draining.
void	requestLocationUpdates() if a LocationEngineListener is setup, registering for location updates will tell the provider to begin sending updates.
void	setPriority(int priority) This method sets the priority of the request, providing this will help the location provide know which location sources to use.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidLocationEngine

public AndroidLocationEngine(android.content.Context context)

Method Detail

getLocationEngine

public static LocationEngine getLocationEngine(android.content.Context context)

activate

public void activate()

Description copied from class: LocationEngine

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 LocationEngine

deactivate

public void deactivate()

Description copied from class: LocationEngine

Disconnect the location engine, 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 LocationEngine

isConnected

public boolean isConnected()

Description copied from class: LocationEngine

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

Specified by:

isConnected in class LocationEngine

Returns:

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

getLastLocation

public android.location.Location getLastLocation()

Description copied from class: LocationEngine

When first initializing the location engine the location updates oftentimes aren't immediate and your user experience might diminish since they are forced to wait till a more accurate update arrives. A solution to this is to request the last known user location. There are no guarantees this won't return null since the Location object is simply stored in cache.

Specified by:

getLastLocation in class LocationEngine

Returns:

The last known user location as a Location object.

requestLocationUpdates

public void requestLocationUpdates()

Description copied from class: LocationEngine

if a LocationEngineListener is setup, registering for location updates will tell the provider to begin sending updates.

Specified by:

requestLocationUpdates in class LocationEngine

setPriority

public void setPriority(int priority)

Description copied from class: LocationEngine

This method sets the priority of the request, providing this will help the location provide know which location sources to use. You'll find more information on the different priority values inside the LocationEnginePriority file.

Overrides:

setPriority in class LocationEngine

Parameters:

priority - One of the LocationEnginePrioritys listed.

removeLocationUpdates

public void removeLocationUpdates()

Description copied from class: LocationEngine

When you no longer wish to receive location updates, you should call this method to prevent the devices battery from draining. It's important to note that your location listeners will remain intake until you call LocationEngine.removeLocationEngineListener(LocationEngineListener).

Specified by:

removeLocationUpdates in class LocationEngine

obtainType

public LocationEngine.Type obtainType()

Description copied from class: LocationEngine

Get the current LocationEngine LocationEngine.Type being used.

Specified by:

obtainType in class LocationEngine

Returns:

one of the location engine types listed inside the LocationEngine.Type enum.

onLocationChanged

public void onLocationChanged(android.location.Location location)

Called when the location has changed.

Specified by:

onLocationChanged in interface android.location.LocationListener

onStatusChanged

public void onStatusChanged(java.lang.String provider,
                            int status,
                            android.os.Bundle extras)

Called when the provider status changes.

Specified by:

onStatusChanged in interface android.location.LocationListener

onProviderEnabled

public void onProviderEnabled(java.lang.String provider)

Called when the provider is enabled by the user.

Specified by:

onProviderEnabled in interface android.location.LocationListener

onProviderDisabled

public void onProviderDisabled(java.lang.String provider)

Called when the provider is disabled by the user.

Specified by:

onProviderDisabled in interface android.location.LocationListener