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

InternalMapGptManager

interface InternalMapGptManager : MapGptManager

This interface provides an entry point to the MapGPT feature.

Inheritors

Properties

Link copied to clipboard
abstract val core: MapGptCore
Link copied to clipboard
abstract 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

Link copied to clipboard
abstract fun attachMapGptPermissionLauncher(activityResultCaller: ActivityResultCaller)

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

Link copied to clipboard
abstract fun createMapGptUI(mapGptUIOptions: MapGptUIOptions): MapGptDetachableUI

Entry point for attaching MapGPT UI to the hosting application.

Link copied to clipboard
fun MapGptManager.createMapGptUI(options: MapGptUIOptions.Builder.() -> Unit): MapGptDetachableUI

Extension function to create a MapGptDetachableUI instance with builder DSL.

Link copied to clipboard
abstract fun detachMapGptPermissionLauncher(activityResultCaller: ActivityResultCaller)

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

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract fun onTeleportedToNewLocation()
Link copied to clipboard
abstract fun setCapabilityMiddleware(middlewares: Set<MapGptCapabilitiesMiddleware<out MiddlewareContext>>)

Sets middleware with MapGPT capabilities.

Link copied to clipboard
abstract fun setEnabled(enabled: Boolean)
Link copied to clipboard
abstract fun setKeyboardModeEnabled(enabled: Boolean)
Link copied to clipboard
abstract fun setMapGptAvatar(avatar: MapGptAvatar)
Link copied to clipboard
abstract fun stopMapGptConversation()

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

Link copied to clipboard
abstract fun toggleMapGptConversation()

Toggle MapGPT avatar.

Link copied to clipboard
abstract fun updateMapGptContextOverrides(update: MapGptContextOverrides.() -> Unit)

Set functions that allow you to override the MapGPT context.