navigation-ux-map-gpt-api/com.mapbox.navigation.mapgpt.api

Package-level declarations

Types

DisabledMapGptManagerImpl

class DisabledMapGptManagerImpl : InternalMapGptManager

This implementation of InternalMapGptManager is used when the MapGPT feature is not available.

InternalMapGptManager

interface InternalMapGptManager : MapGptManager

This interface provides an entry point to the MapGPT feature.

LottieMapGptAvatar

class LottieMapGptAvatar(val name: String, @RawRes val listeningToUser: Int, @RawRes val userSpeaking: Int, @RawRes val aiThinking: Int, @RawRes val aiSpeaking: Int, @RawRes val aiError: Int, @RawRes val aiNonCriticalError: Int = aiError, @RawRes val aiIdle: Int, @RawRes val aiSleeping: Int, @RawRes val noMicPermission: Int, @RawRes val serviceDisconnected: Int) : MapGptAvatar

Represents an Avatar which is animated with Lottie json resources.

MapGptApiTokens

class MapGptApiTokens(val mapGptApiToken: String)

This object is temporary for exposing the api tokens through the DashConfig. Likely that each token will be exposed as a feature in the future.

MapGptAvatar

sealed class MapGptAvatar

Is an animating representation of the MapGPT assistant.

MapGptAvatarPosition

object MapGptAvatarPosition

The MapGptUIOptions class allows you to customize the UI of the MapGpt SDK. The position of the avatar used for the overall layout of the UI.

MapGptDetachableUI

interface MapGptDetachableUI

MapGptManager

interface MapGptManager

This interface can be used to invoke specific functions related to MapGPT.

MapGptState

data class MapGptState(val enabled: Boolean = false, val conversationActive: Boolean = false, val uiVisible: Boolean = false, val profileId: String = "", val bottomBarHeight: Int = 0)

MapGptUIOptions

class MapGptUIOptions

NoMapGptDetachableUI

object NoMapGptDetachableUI : MapGptDetachableUI

Properties

MAP_GPT_AVATAR

const val MAP_GPT_AVATAR: String

MAP_GPT_CAROUSEL

const val MAP_GPT_CAROUSEL: String

MAP_GPT_CONFIDENTIAL_LABEL

const val MAP_GPT_CONFIDENTIAL_LABEL: String

MAP_GPT_SCREEN

const val MAP_GPT_SCREEN: String

MAP_GPT_THEME_ID

const val MAP_GPT_THEME_ID: String

Functions

createMapGptUI

fun MapGptManager.createMapGptUI(options: MapGptUIOptions.Builder.() -> Unit): MapGptDetachableUI

Extension function to create a MapGptDetachableUI instance with builder DSL.