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

DashMapGptConfig

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

@Serializable

class DashMapGptConfig : DashConfigBase<DashMapGptConfig, DashMapGptConfig.Builder>

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.

capabilities

Set capabilities to be handled external from the SDK.

capabilitiesMiddleware

Set middleware to handle capabilities.

microphoneMiddleware

The microphone middleware to be used with some userInputMiddleware.

userInputMiddleware

The user input middleware to use for MapGPT.

musicPlayerMiddleware

The music player middleware to use for MapGPT.

wakeWordMiddleware

The wake word middleware to use for MapGPT.

Types

Builder

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

@Serializable

class Builder : DashConfigBuilder<DashMapGptConfig, DashMapGptConfig.Builder> , DashMapGptInit

Creates a new instance of DashMapGptConfig.

Properties

avatar

val avatar: MapGptAvatar? = null

capabilities

val capabilities: Set<MapGptCapability>

capabilitiesMiddleware

val capabilitiesMiddleware: Set<MapGptCapabilitiesMiddleware<out MiddlewareContext>>

customValues

@Serializable(with = RedactedMapSerializer::class)

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

isEnabled

val isEnabled: Boolean

isKeyboardModeEnabled

val isKeyboardModeEnabled: Boolean

isSettingsMenuEnabled

val isSettingsMenuEnabled: Boolean

microphoneMiddleware

val microphoneMiddleware: Set<PlatformMicrophoneMiddleware>

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