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

DashConfig

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

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

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.

environment

The environment in which the plugin is being used.

applicationId

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

versionName

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

device

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

logLevel

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

unitOfMeasurement

configures default unit of measurements.

engineType

configures vehicle's engine type.

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.

Types

Builder

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

Creates a new instance of DashConfig.

Companion

object Companion

Update

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

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

Properties

accessToken

val accessToken: String

analytics

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

var DashConfiguration.analytics: DashAnalyticsConfig

Configuration for the analytics.

applicationContext

val applicationContext: Context

applicationId

val applicationId: String

cameraConfig

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

var DashConfiguration.cameraConfig: DashCameraConfig

Camera configuration.

customLocationProviderFactoryConfig

val customLocationProviderFactoryConfig: CustomLocationFactoryProviderConfig?

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.

device

val device: DashDeviceType

engineType

val engineType: String?

environment

val environment: String

etaPanelConfig

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

var DashConfiguration.etaPanelConfig: DashEtaPanelConfig

ETA panel configuration.

locale

val locale: Locale

locationSimConfig

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

var DashConfiguration.locationSimConfig: DashLocationSimConfig

Configuration for the location simulation.

logLevel

val logLevel: Int

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

val unitOfMeasurement: String

versionName

val versionName: String

voicesConfig

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

var DashConfiguration.voicesConfig: DashVoicesConfig

Voices configuration.

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.