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

Update

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

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

Constructors

Update

constructor(config: DashConfig)

Properties

analytics

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

var DashConfiguration.analytics: DashAnalyticsConfig

Configuration for the analytics.

cameraConfig

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

var DashConfiguration.cameraConfig: DashCameraConfig

Camera configuration.

customValues

open override val customValues: MutableMap<String, Any?>

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.

driverNotificationConfig

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

var DashConfiguration.driverNotificationConfig: DashDriverNotificationConfig

Driver notification configuration.

etaPanelConfig

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

var DashConfiguration.etaPanelConfig: DashEtaPanelConfig

ETA panel configuration.

locationSimConfig

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

var DashConfiguration.locationSimConfig: DashLocationSimConfig

Configuration for the location simulation.

logLevel

open override var logLevel: Int

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

mapGptConfig

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

var DashConfiguration.mapGptConfig: DashMapGptConfig

Voice Assistant configuration.

mapStyleConfig

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

var DashConfiguration.mapStyleConfig: DashMapStyleConfig

Mapbox Maps styles configuration.

offlineConfig

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

var DashConfiguration.offlineConfig: DashOfflineConfig

routeOptionsConfig

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

var DashConfiguration.routeOptionsConfig: DashRouteOptionsConfig

Configuration options for route options.

searchConfig

@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.

themeConfig

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

var DashConfiguration.themeConfig: DashThemeConfig

Dash UI elements appearance configuration.

uiConfig

@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.

voicesConfig

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

var DashConfiguration.voicesConfig: DashVoicesConfig

Voices configuration.

Functions

applyUpdateTo

open override fun applyUpdateTo(config: DashConfig): DashConfig

Create base config class with the update applied.

destinationPreview

fun DashUpdate.destinationPreview(f: DashDestinationPreviewUpdate.() -> Unit)

Re-configures UI routing.

driverNotification

fun DashUpdate.driverNotification(f: DashDriverNotificationConfigUpdate.() -> Unit)

Re-configures the driver notifications

etaPanel

fun DashUpdate.etaPanel(f: DashEtaPanelConfigUpdate.() -> Unit)

Re-configures the ETA panel.

mapGpt

fun DashUpdate.mapGpt(f: DashMapGptUpdate.() -> Unit)

Re-configures voice assistant.

mapStyle

fun DashUpdate.mapStyle(f: DashMapStyleUpdate.() -> Unit)

Re-configures the Mapbox Maps styles used with Dash.

routeOptions

fun DashUpdate.routeOptions(f: DashRouteOptionsUpdate.() -> Unit)

Re-configures the route options.

fun DashUpdate.search(f: DashSearchUpdate.() -> Unit)

Re-configures search.

speedLimitsOptions

fun DashUpdate.speedLimitsOptions(f: DashSpeedLimitsUpdate.() -> Unit)

Re-configures speed limits options.

theme

fun DashUpdate.theme(f: DashThemeUpdate.() -> Unit)

Re-configures appearance of Dash's UI elements.

fun DashUpdate.ui(f: DashUiUpdate.() -> Unit)

Re-configures UI properties.

uiSettings

fun DashUpdate.uiSettings(f: DashUiSettingsUpdate.() -> Unit)

Re-configures UI Settings

voices

fun DashUpdate.voices(f: DashVoicesUpdate.() -> Unit)

Re-configures the voices used for Dash Navigation and MapGPT.