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

DashMapGptConfig

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

Configuration for the MapGPT feature.

Parameters

isEnabled

Enables or disables the MapGPT feature.

isSettingsMenuEnabled

Enables or disables the MapGPT settings menu.

avatar

Allows for custom avatar animations.

isKeyboardModeEnabled

Enables or disables the MapGPT keyboard mode.

profileId

The profile ID to use for MapGPT.

userInputMiddleware

The user input middleware to use for MapGPT.

Types

Builder

class Builder : DashConfigBuilder<DashMapGptConfig, DashMapGptConfig.Builder>

Creates a new instance of DashMapGptConfig.

Companion

object Companion

Update

class Update : ConfigUpdate<DashMapGptConfig>

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

Properties

avatar

val avatar: MapGptAvatar?

capabilities

val capabilities: Set<MapGptCapability>

customValues

val customValues: Map<String, Any>

isEnabled

val isEnabled: Boolean

isKeyboardModeEnabled

val isKeyboardModeEnabled: Boolean

isSettingsMenuEnabled

val isSettingsMenuEnabled: Boolean

musicPlayerMiddleware

val musicPlayerMiddleware: Set<MusicPlayerMiddleware>

profileId

val profileId: String

userInputMiddleware

val userInputMiddleware: Set<UserInputOwnerMiddleware>

wakeWordMiddleware

val wakeWordMiddleware: Set<WakeWordMiddleware>

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(): DashMapGptConfig.Builder

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

toString

open override fun toString(): String

update

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

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