com.mapbox.android.core.location

Class LocationEngineRequest.Builder

java.lang.Object

com.mapbox.android.core.location.LocationEngineRequest.Builder

Enclosing class:

LocationEngineRequest

public static final class LocationEngineRequest.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder(long interval) Default builder constructor.

Method Summary

Modifier and Type	Method and Description
LocationEngineRequest	build() Builds request object.
LocationEngineRequest.Builder	setDisplacement(float displacement) Set distance between location updates.
LocationEngineRequest.Builder	setFastestInterval(long interval) Sets the fastest interval in milliseconds for location updates.
LocationEngineRequest.Builder	setMaxWaitTime(long maxWaitTime) Sets the maximum wait time in milliseconds for location updates.
LocationEngineRequest.Builder	setPriority(int priority) Set priority for request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(long interval)

Default builder constructor.

Parameters:

interval - default interval between location updates

Since:

1.0.0

Method Detail

setPriority

public LocationEngineRequest.Builder setPriority(int priority)

Set priority for request. Use priority constant: LocationEngineRequest.PRIORITY_HIGH_ACCURACY

Parameters:

priority - constant

Returns:

reference to builder

Since:

1.0.0

setDisplacement

public LocationEngineRequest.Builder setDisplacement(float displacement)

Set distance between location updates.

Parameters:

displacement - distance between locations in meters.

Returns:

reference to builder

Since:

1.0.0

setMaxWaitTime

public LocationEngineRequest.Builder setMaxWaitTime(long maxWaitTime)

Sets the maximum wait time in milliseconds for location updates.

Locations determined at intervals but delivered in batch based on wait time. Batching is not supported by all engines.

Parameters:

maxWaitTime - wait time in milliseconds.

Returns:

reference to builder

Since:

1.0.0

setFastestInterval

public LocationEngineRequest.Builder setFastestInterval(long interval)

Sets the fastest interval in milliseconds for location updates.

Parameters:

interval - fastest interval in milliseconds.

Returns:

reference to builder

Since:

1.0.0

build

public LocationEngineRequest build()

Builds request object.

Returns:

instance of location request.

Since:

1.0.0