com.mapbox.mapboxsdk.location.engine

Interface LocationEngine

public interface LocationEngine

Generic location engine interface wrapper for the location providers. Default providers bundled with Mapbox location library: Android location provider and Google Play Services fused location provider

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
void	getLastLocation(LocationEngineCallback<LocationEngineResult> callback) Returns the most recent location currently available.
void	removeLocationUpdates(LocationEngineCallback<LocationEngineResult> callback) Removes location updates for the given location engine callback.
void	removeLocationUpdates(android.app.PendingIntent pendingIntent) Removes location updates for the given pending intent.
void	requestLocationUpdates(LocationEngineRequest request, LocationEngineCallback<LocationEngineResult> callback, android.os.Looper looper) Requests location updates with a callback on the specified Looper thread.
void	requestLocationUpdates(LocationEngineRequest request, android.app.PendingIntent pendingIntent) Requests location updates with callback on the specified PendingIntent.

Method Detail

getLastLocation

void getLastLocation(@NonNull
                     LocationEngineCallback<LocationEngineResult> callback)
              throws java.lang.SecurityException

Returns the most recent location currently available.

If a location is not available, which should happen very rarely, null will be returned.

Parameters:

callback - LocationEngineCallback for the location result LocationEngineResult.

Throws:

java.lang.SecurityException - if permission is not granted to access location services.

Since:

1.0.0

requestLocationUpdates

void requestLocationUpdates(@NonNull
                            LocationEngineRequest request,
                            @NonNull
                            LocationEngineCallback<LocationEngineResult> callback,
                            @Nullable
                            android.os.Looper looper)
                     throws java.lang.SecurityException

Requests location updates with a callback on the specified Looper thread.

Parameters:

request - LocationEngineRequest for the updates.

callback - LocationEngineCallback for the location result LocationEngineResult.

looper - The Looper object whose message queue will be used to implement the callback mechanism, or null to invoke callbacks on the main thread.

Throws:

java.lang.SecurityException - if permission is not granted to access location services.

Since:

1.0.0

requestLocationUpdates

void requestLocationUpdates(@NonNull
                            LocationEngineRequest request,
                            android.app.PendingIntent pendingIntent)
                     throws java.lang.SecurityException

Requests location updates with callback on the specified PendingIntent.

Parameters:

request - LocationEngineRequest for the updates.

pendingIntent - PendingIntent for the location result LocationEngineResult.

Throws:

java.lang.SecurityException - if permission is not granted to access location services.

Since:

1.1.0

removeLocationUpdates

void removeLocationUpdates(@NonNull
                           LocationEngineCallback<LocationEngineResult> callback)

Removes location updates for the given location engine callback.

It is recommended to remove location requests when the activity is in a paused or stopped state, doing so helps battery performance.

Parameters:

callback - LocationEngineCallback to remove.

Since:

1.0.0

removeLocationUpdates

void removeLocationUpdates(android.app.PendingIntent pendingIntent)

Removes location updates for the given pending intent.

It is recommended to remove location requests when the activity is in a paused or stopped state, doing so helps battery performance.

Parameters:

pendingIntent - PendingIntent to remove.

Since:

1.1.0