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

DashConfig

class DashConfig : DashConfigBase<DashConfig, DashConfig.Builder> , UpdatableConfig<DashConfig, DashConfig.Update>

Primary configuration of Dash that's applied on initialization time. After initialization, a subset of available configuration options can be mutated at any point in time via update and provided to Dash.applyUpdate.

Parameters

applicationContext

context of the application.

accessToken

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

locale

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

device

one of DashDeviceType values that defines the type of device on which the app is running.

realLocationProviderFactory

a factory that creates a custom DeviceLocationProvider implementation used with Dash. that emits only real locations (i. e. not simulated or fake). If null, a default engine will be created under-the-hood.

preferLocalTts

enables or disables the local TTS engine. The setting affects any of voice interactions: voice guidance, voice assistant, and etc.

themeConfig

configures appearance of Dash's UI elements.

mapStyleConfig

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

mapGptConfig

configures the Mapbox MapGPT feature used within Dash.

uiConfig

configures UI appearance of Dash.

unitOfMeasurement

configures default unit of measurements.

engineType

configures vehicle's engine type.

Types

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

Creates a new instance of DashConfig.

object Companion

class Update(config: DashConfig) : ConfigUpdate<DashConfig>

Defines configuration options available to be updated in the runtime. See Dash.applyUpdate.

Properties

val accessToken: String

applicationContext

val applicationContext: Context

val cameraConfig: DashCameraConfig

val customValues: Map<String, Any>

destinationPreviewConfig

val destinationPreviewConfig: DashDestinationPreviewConfig

val device: DashDeviceType

val engineType: String?

val locale: Locale

locationSimConfig

val locationSimConfig: DashLocationSimConfig

val logLevel: Int

val mapGptConfig: DashMapGptConfig

val mapStyleConfig: DashMapStyleConfig

val preferLocalTts: Boolean

realLocationProviderFactory

val realLocationProviderFactory: DeviceLocationProviderFactory?

routeOptionsConfig

val routeOptionsConfig: DashRouteOptionsConfig

val searchConfig: DashSearchConfig

speedLimitsOptionsConfig

val speedLimitsOptionsConfig: DashSpeedLimitsOptionsConfig

val themeConfig: DashThemeConfig

val uiConfig: DashUiConfig

uiSettingsConfig

val uiSettingsConfig: DashUiSettingsConfig

unitOfMeasurement

val unitOfMeasurement: String

val voicesConfig: DashVoicesConfig

val weatherConfig: DashWeatherConfig

Functions

fun <T, B : DashConfigBuilder<T, B>> DashConfigBase<T, B>.copy(func: B.() -> Unit): T

Creates a copy of a given configuration instances with options mutated by the provided function.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toBuilder(): DashConfig.Builder

Returns a new Builder instance with copied elements of this configuration.

open override fun toString(): String

open override fun update(func: DashConfig.Update.() -> Unit): DashConfig.Update

Returns a configuration update builder that can be used with Dash.applyUpdate.