Mapbox Maps Android/com.mapbox.maps.plugin.location/LocationComponentActivationOptions/Builder

Builder

Builder class for constructing a new instance of LocationComponentActivationOptions .

open class Builder

Constructors

Builder

Constructor for the LocationComponentActivationOptions builder class. While other activation options are optional, the activation process always requires context and a fully-loaded map StyleManagerInterface object, which is why the two are in this constructor.

open fun Builder(context: Context, style: StyleManagerInterface)

Functions

build

Method which actually builds the LocationComponentActivationOptions object while taking the various options into account.

open fun build(): LocationComponentActivationOptions

locationComponentOptions

a built LocationComponentOptions object, which holds the various LocationPluginImpl styling options

open fun locationComponentOptions(locationComponentOptions: LocationComponentOptions): LocationComponentActivationOptions.Builder

locationEngine

Deliver your own LocationEngine to the LocationComponent.

The true/false useDefaultLocationEngine activation option is ignored when a non-null LocationEngine is set via this `locationEngine()` method.

@NonNull()

open fun locationEngine(locationEngine: LocationEngine): LocationComponentActivationOptions.Builder

locationEngineRequest

the location request which the LocationPluginImpl should use

open fun locationEngineRequest(locationEngineRequest: LocationEngineRequest): LocationComponentActivationOptions.Builder

locationModelLayerOptions

a build LocationModelLayerOptions object, which holds he various LocationPluginImpl 3D model styling options

open fun locationModelLayerOptions(locationModelLayerOptions: LocationModelLayerOptions): LocationComponentActivationOptions.Builder

styleRes

the LocationComponent style resource (e.g. R.style.style_name)

open fun styleRes(styleRes: Int): LocationComponentActivationOptions.Builder

useDefaultLocationEngine

true if you want to initialize and use the built-in location engine or false if there should be no location engine initialized This is ignored when null is set as the parameter for (Context, MapStyleDelegate)#locationEngine() .

open fun useDefaultLocationEngine(useDefaultLocationEngine: Boolean): LocationComponentActivationOptions.Builder