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> , DashInit

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

open override val accessToken: String

applicationContext

val applicationContext: Context

open override var applicationId: String

The application ID of the app that the plugin is being used in.

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.cameraConfig: DashCameraConfig

Camera configuration.

customLocationProviderFactoryConfig

open override 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.

debugSettingsConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.debugSettingsConfig: DashDebugSettingsConfig

Configuration for the debug settings.

destinationPreviewConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.destinationPreviewConfig: DashDestinationPreviewConfig

Configuration options for UI routing.

open override 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.

open override var engineType: String?

Configures vehicle's engine type.

open override var environment: String

The environment in which the plugin is being used.

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.etaPanelConfig: DashEtaPanelConfig

ETA panel configuration.

open override var locale: Locale

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

locationSimConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.locationSimConfig: DashLocationSimConfig

Configuration for the location simulation.

open override var logLevel: Int

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

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.mapGptConfig: DashMapGptConfig

Voice Assistant configuration.

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.mapStyleConfig: DashMapStyleConfig

Mapbox Maps styles configuration.

routeOptionsConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.routeOptionsConfig: DashRouteOptionsConfig

Configuration options for route options.

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.searchConfig: DashSearchConfig

Search configuration.

speedLimitsOptionsConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.speedLimitsOptionsConfig: DashSpeedLimitsOptionsConfig

Configuration for speed limits options.

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.themeConfig: DashThemeConfig

Dash UI elements appearance configuration.

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.uiConfig: DashUiConfig

Ui configuration.

uiSettingsConfig

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.uiSettingsConfig: DashUiSettingsConfig

Configuration for settings screen.

unitOfMeasurement

open override var unitOfMeasurement: String

Configures default unit of measurement.

open override var versionName: String

The version name of the app that the plugin is being used in.

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

var DashConfiguration.voicesConfig: DashVoicesConfig

Voices configuration.

Functions

open override fun build(): DashConfig

Creates a new instance of DashConfig.

fun DashInit.camera(f: DashCameraInit.() -> Unit)

Configures camera behavior.

fun DashInit.debugSettings(f: DashDebugSettingsConfigInit.() -> Unit)

Configures debug settings.

destinationPreview

fun DashInit.destinationPreview(f: DashDestinationPreviewInit.() -> Unit)

Configures UI routing.

fun DashInit.etaPanel(f: DashEtaPanelConfigInit.() -> Unit)

Configures the ETA panel.

locationSimulation

fun DashInit.locationSimulation(f: DashLocationSimInit.() -> Unit)

Configures the location simulation.

fun DashInit.mapGpt(f: DashMapGptInit.() -> Unit)

Configures voice assistant.

fun DashInit.mapStyle(f: DashMapStyleInit.() -> Unit)

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

fun DashInit.routeOptions(f: DashRouteOptionsInit.() -> Unit)

Configures the route options.

fun DashInit.search(f: DashSearchInit.() -> Unit)

Configures search.

speedLimitsOptions

fun DashInit.speedLimitsOptions(f: DashSpeedLimitsInit.() -> Unit)

Configures speed limits options.

fun DashInit.theme(f: DashThemeInit.() -> Unit)

Configures appearance of Dash's UI elements.

fun DashInit.ui(f: DashUiInit.() -> Unit)

Configures UI properties.

fun DashInit.uiSettings(f: DashUiSettingsInit.() -> Unit)

Configures UI Settings

fun DashInit.voices(f: DashVoicesInit.() -> Unit)

Configures the voices used for Dash Navigation and MapGPT.