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.

customLocationProviderFactoryConfig

a config for a 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:

Location.Builder#extra(Value.valueOf(hashMapOf(LocationExtraKeys.IS_MOCK to Value.valueOf(true/false))))

If not set, the default location provider will be used.

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

Builder

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

Creates a new instance of DashConfig.

Companion

object Companion

Update

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

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

Properties

accessToken

val accessToken: String

applicationContext

val applicationContext: Context

cameraConfig

val cameraConfig: DashCameraConfig

customLocationProviderFactoryConfig

val customLocationProviderFactoryConfig: CustomLocationFactoryProviderConfig?

customValues

val customValues: Map<String, Any>

destinationPreviewConfig

val destinationPreviewConfig: DashDestinationPreviewConfig

device

val device: DashDeviceType

engineType

val engineType: String?

locale

val locale: Locale

locationSimConfig

val locationSimConfig: DashLocationSimConfig

logLevel

val logLevel: Int

mapGptConfig

val mapGptConfig: DashMapGptConfig

mapStyleConfig

val mapStyleConfig: DashMapStyleConfig

preferLocalTts

val preferLocalTts: Boolean

routeOptionsConfig

val routeOptionsConfig: DashRouteOptionsConfig

searchConfig

val searchConfig: DashSearchConfig

speedLimitsOptionsConfig

val speedLimitsOptionsConfig: DashSpeedLimitsOptionsConfig

themeConfig

val themeConfig: DashThemeConfig

uiConfig

val uiConfig: DashUiConfig

uiSettingsConfig

val uiSettingsConfig: DashUiSettingsConfig

unitOfMeasurement

val unitOfMeasurement: String

voicesConfig

val voicesConfig: DashVoicesConfig

weatherConfig

val weatherConfig: DashWeatherConfig

Functions

copy

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.

equals

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

hashCode

open override fun hashCode(): Int

toBuilder

open override fun toBuilder(): DashConfig.Builder

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

toString

open override fun toString(): String

update

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

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