navigation-ux-dash-config/com.mapbox.dash.sdk.config.api/DashConfig/Builder

Builder

class Builder(val applicationContext: Context, val accessToken: String) : DashConfigBuilder<DashConfig, DashConfig.Builder>

Creates a new instance of DashConfig.

Parameters

applicationContext

context of the application.

accessToken

access token from your Mapbox account. You can create a new one in your Mapbox Account.

Constructors

constructor(applicationContext: Context, accessToken: String)

Properties

val accessToken: String

applicationContext

val applicationContext: Context

var cameraConfig: DashCameraConfig

Configures camera.

customLocationProviderFactoryConfig

var customLocationProviderFactoryConfig: CustomLocationFactoryProviderConfig?

A config for custom location provider implementation. See CustomLocationFactoryProviderConfig for details. Note that in the config you must specify a location provider type: LocationProviderType.REAL, LocationProviderType.MOCKED or LocationProviderType.MIXED. Note that locations emitted by a custom location provider must set a valid value for isMock extra flag: real locations must have it set to false or not set at all, while mocked/simulated locations must have it set to true. Every location object specifies this flag, so if your location provider's type is LocationProviderType.MIXED, emitted locations will just have different flag values, depending on whether they are real or mocked. To set this flag, use:

open var customValues: MutableMap<String, Any>

Map of custom configuration key -> value pairs.

destinationPreviewConfig

var destinationPreviewConfig: DashDestinationPreviewConfig

Configures DestinationPreview.

var device: DashDeviceType

DashDeviceType that defines the type of device on which the app is running. The type of device providing data to the navigator.

var engineType: String?

Configures vehicle's engine type.

var locale: Locale

Locale that should be used for guidance instruction and other localization features.

locationSimConfig

var locationSimConfig: DashLocationSimConfig

Configures location simulation.

var logLevel: Int

One of LogsExtra levels to define the logs that should be produced by Dash SDK.

var mapGptConfig: DashMapGptConfig

Configures the Mapbox MapGPT feature used within Dash.

var mapStyleConfig: DashMapStyleConfig

Configures the Mapbox Maps styles used with Dash. You can edit or create new ones via Mapbox Studio.

var preferLocalTts: Boolean

Configures the TTS engine: local or remote.

routeOptionsConfig

var routeOptionsConfig: DashRouteOptionsConfig

Configures route options.

var searchConfig: DashSearchConfig

Configures Search.

speedLimitsOptionsConfig

var speedLimitsOptionsConfig: DashSpeedLimitsOptionsConfig

Configure speed limits options.

var themeConfig: DashThemeConfig

Configures appearance of Dash's UI elements.

var uiConfig: DashUiConfig

Configures UI.

uiSettingsConfig

var uiSettingsConfig: DashUiSettingsConfig

Configures UI Settings.

unitOfMeasurement

var unitOfMeasurement: String

Configures default unit of measurement.

var voicesConfig: DashVoicesConfig

Configures the voices used for Dash Navigation and MapGPT.

var weatherConfig: DashWeatherConfig

Configures Weather.

Functions

open override fun build(): DashConfig

Creates a new instance of DashConfig.

fun camera(func: DashCameraConfig.Builder.() -> Unit): DashConfig.Builder

Configures camera.

fun ~~cameraConfig~~(func: DashCameraConfig.Builder.() -> Unit): DashConfig.Builder

Configures camera.

destinationPreview

fun destinationPreview(func: DashDestinationPreviewConfig.Builder.() -> Unit): DashConfig.Builder

Configures DestinationPreview.

destinationPreviewConfig

fun ~~destinationPreviewConfig~~(func: DashDestinationPreviewConfig.Builder.() -> Unit): DashConfig.Builder

Configures DestinationPreview.

locationSimulation

fun locationSimulation(func: DashLocationSimConfig.Builder.() -> Unit): DashConfig.Builder

Configures location simulation.

fun mapGpt(func: DashMapGptConfig.Builder.() -> Unit): DashConfig.Builder

Configures the Mapbox MapGPT feature used within Dash.

fun ~~mapGptConfig~~(func: DashMapGptConfig.Builder.() -> Unit): DashConfig.Builder

Configures the Mapbox MapGPT feature used within Dash.

fun mapStyle(func: DashMapStyleConfig.Builder.() -> Unit): DashConfig.Builder

Configures the Mapbox Maps styles used with Dash. You can edit or create new ones via Mapbox Studio.

fun ~~mapStyleConfig~~(func: DashMapStyleConfig.Builder.() -> Unit): DashConfig.Builder

Configures the Mapbox Maps styles used with Dash. You can edit or create new ones via Mapbox Studio.

fun routeOptions(func: DashRouteOptionsConfig.Builder.() -> Unit): DashConfig.Builder

Configures route options.

routeOptionsConfig

fun ~~routeOptionsConfig~~(func: DashRouteOptionsConfig.Builder.() -> Unit): DashConfig.Builder

Configures route options.

fun search(func: DashSearchConfig.Builder.() -> Unit): DashConfig.Builder

Configures Search.

fun ~~searchConfig~~(func: DashSearchConfig.Builder.() -> Unit): DashConfig.Builder

Configures Search.

speedLimitsOptions

fun speedLimitsOptions(func: DashSpeedLimitsOptionsConfig.Builder.() -> Unit): DashConfig.Builder

Configures speed limits.

speedLimitsOptionsConfig

fun ~~speedLimitsOptionsConfig~~(func: DashSpeedLimitsOptionsConfig.Builder.() -> Unit): DashConfig.Builder

Configures speed limits.

fun theme(func: DashThemeConfig.Builder.() -> Unit): DashConfig.Builder

Configures appearance of Dash's UI elements.

fun ~~themeConfig~~(func: DashThemeConfig.Builder.() -> Unit): DashConfig.Builder

Configures appearance of Dash's UI elements.

fun ui(func: DashUiConfig.Builder.() -> Unit): DashConfig.Builder

Configure UI setup.

fun ~~uiConfig~~(func: DashUiConfig.Builder.() -> Unit): DashConfig.Builder

Configure UI setup.

fun uiSettings(func: DashUiSettingsConfig.Builder.() -> Unit): DashConfig.Builder

Configures UI Settings.

uiSettingsConfig

fun ~~uiSettingsConfig~~(func: DashUiSettingsConfig.Builder.() -> Unit): DashConfig.Builder

Configures UI Settings.

fun voices(func: DashVoicesConfig.Builder.() -> Unit): DashConfig.Builder

Configuration settings for the Text to Speech voices utilized by Dash.

fun ~~voicesConfig~~(func: DashVoicesConfig.Builder.() -> Unit): DashConfig.Builder

Configuration settings for the Text to Speech voices utilized by Dash.

fun weather(func: DashWeatherConfig.Builder.() -> Unit): DashConfig.Builder

Configures Weather.

fun ~~weatherConfig~~(func: DashWeatherConfig.Builder.() -> Unit): DashConfig.Builder

Configures Weather.