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

DisabledMapGptManagerImpl

class DisabledMapGptManagerImpl : InternalMapGptManager

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

Constructors

constructor()

Properties

core

open override val core: MapGptCore

state

open override val state: StateFlow<MapGptState>

When MapGPT is available this value can be used to observe if the feature is enabled or its UI is visible.

Functions

attachMapGptPermissionLauncher

open override fun attachMapGptPermissionLauncher(activityResultCaller: ActivityResultCaller)

Call this in your Activity or Fragment #onCreate function to allow MapGPT to register the necessary permission launcher.

createMapGptUI

open override fun createMapGptUI(mapGptUIOptions: MapGptUIOptions): MapGptDetachableUI

Entry point for attaching MapGPT UI to the hosting application.

createMapGptUI

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

Extension function to create a MapGptDetachableUI instance with builder DSL.

detachMapGptPermissionLauncher

open override fun detachMapGptPermissionLauncher(activityResultCaller: ActivityResultCaller)

Call this in your Activity or Fragment #onDestory function to allow MapGPT to unregister the permission launcher.

editCapabilitySettings

open override fun editCapabilitySettings(func: MutableSet<MapGptCapabilitySetting>.() -> Unit)

The capability settings give users an ability to override capabilities of the MapGPT SDK through the settings screen. This function allows you to edit the capability settings available to enable or disable from the settings user interface.

onTeleportedToNewLocation

open override fun onTeleportedToNewLocation()

setCapabilityMiddleware

open override fun setCapabilityMiddleware(middlewares: Set<MapGptCapabilitiesMiddleware<out MiddlewareContext>>)

Sets middleware with MapGPT capabilities.

setEnabled

open override fun setEnabled(enabled: Boolean)

setKeyboardModeEnabled

open override fun setKeyboardModeEnabled(enabled: Boolean)

setMapGptAvatar

open override fun setMapGptAvatar(avatar: MapGptAvatar)

stopMapGptConversation

open override fun stopMapGptConversation()

Call this in your Activity or Fragment to force stop the avatar as required.

toggleMapGptConversation

open override fun toggleMapGptConversation()

Toggle MapGPT avatar.

updateMapGptContextOverrides

open override fun updateMapGptContextOverrides(update: MapGptContextOverrides.() -> Unit)

Set functions that allow you to override the MapGPT context.