com.mapbox.android.core.location

Class LocationEngineRequest

java.lang.Object

com.mapbox.android.core.location.LocationEngineRequest

public class LocationEngineRequest
extends java.lang.Object

Data model that contains parameters for location engine requests.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocationEngineRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRIORITY_BALANCED_POWER_ACCURACY Used with LocationEngineRequest.Builder.setPriority(int) to request coarse location that is battery optimized.
static int	PRIORITY_HIGH_ACCURACY Used with LocationEngineRequest.Builder.setPriority(int) to request the most accurate location.
static int	PRIORITY_LOW_POWER Used with LocationEngineRequest.Builder.setPriority(int) to request coarse ~ 10 km accuracy location.
static int	PRIORITY_NO_POWER Used with LocationEngineRequest.Builder.setPriority(int) to request passive location: no locations will be returned unless a different client has requested location updates.

Method Summary

Modifier and Type	Method and Description
float	getDisplacement() Returns distance between location updates.
long	getFastestInterval() Returns fastest interval in milliseconds for location updates.
long	getInterval() Returns desired interval between location updates in milliseconds.
long	getMaxWaitTime() Returns maximum wait time in milliseconds for location updates.
int	getPriority() Returns desired quality of the request.

Methods inherited from class java.lang.Object

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

Field Detail

PRIORITY_HIGH_ACCURACY

public static final int PRIORITY_HIGH_ACCURACY

Used with LocationEngineRequest.Builder.setPriority(int) to request the most accurate location.

Since:

1.0.0

See Also:

Constant Field Values

PRIORITY_BALANCED_POWER_ACCURACY

public static final int PRIORITY_BALANCED_POWER_ACCURACY

Used with LocationEngineRequest.Builder.setPriority(int) to request coarse location that is battery optimized.

Since:

1.0.0

See Also:

Constant Field Values

PRIORITY_LOW_POWER

public static final int PRIORITY_LOW_POWER

Used with LocationEngineRequest.Builder.setPriority(int) to request coarse ~ 10 km accuracy location.

Since:

1.0.0

See Also:

Constant Field Values

PRIORITY_NO_POWER

public static final int PRIORITY_NO_POWER

Used with LocationEngineRequest.Builder.setPriority(int) to request passive location: no locations will be returned unless a different client has requested location updates.

Since:

1.0.0

See Also:

Constant Field Values

Method Detail

getInterval

public long getInterval()

Returns desired interval between location updates in milliseconds.

Returns:

desired interval in milliseconds.

Since:

1.0.0

getPriority

public int getPriority()

Returns desired quality of the request.

Returns:

accuracy constant.

Since:

1.0.0

getDisplacement

public float getDisplacement()

Returns distance between location updates.

Returns:

distance between location updates in meters.

Since:

1.0.0

getMaxWaitTime

public long getMaxWaitTime()

Returns maximum wait time in milliseconds for location updates.

Returns:

maximum wait time in milliseconds.

Since:

1.0.0

getFastestInterval

public long getFastestInterval()

Returns fastest interval in milliseconds for location updates.

Returns:

fastest interval in milliseconds.

Since:

1.0.0