appsuite_navappcomponents_api_common_frontend/com.tomtom.ivi.appsuite.navappcomponents.api.common.frontend

Package-level declarations

Types

data class CameraModeOverrideContext(val lifecycleOwner: LifecycleOwner, val iviServiceProvider: IviServiceProvider, val staticConfigurationProvider: StaticConfigurationProvider)

Contains additional data for the CameraModeOverrideProvider.

CameraModeOverrideFrontendExtension

@IviExperimental(reasons = [])

data class CameraModeOverrideFrontendExtension(val cameraModeOverrideProvider: CameraModeOverrideProvider = object : CameraModeOverrideProvider {}) : FrontendExtension

A FrontendExtension that allows for overriding the map camera mode.

CameraModeOverrideProvider

@IviExperimental(reasons = [])

interface CameraModeOverrideProvider

Provides a Flow of the map camera mode to use.

FrontendNavAppComponentsDisplayManager

@IviExperimental(reasons = [])

class FrontendNavAppComponentsDisplayManager : NavAppComponentsDisplayManager

A NavAppComponentsDisplayManager that supports operations for the given componentTags.

MapCameraMode

sealed class MapCameraMode

Mode for the camera that determines from what perspective the map is shown.

NavAppComponentsDisplayManager

@IviExperimental(reasons = [])

interface NavAppComponentsDisplayManager : LifecycleOwner

A manager for the NavApp Components' representation within a display. This interface provides shared instances for various frontends within the same display, allowing the global NavApp state to be managed in a centralized place without frontends having any dependency on each other.

NavAppFragment

@IviExperimental(reasons = [])

abstract class NavAppFragment<P : AnyPanel, VM : FrontendViewModel<P>>(viewModelClass: KClass<VM>) : IviFragment<P, VM>

Base case class for Fragments that needs to be shown by Automotive UI. It integrates with Automotive UI using the StockNavAppComponentsDisplayManager.

StockNavAppComponentsDisplayManager

@IviExperimental(reasons = [])

class StockNavAppComponentsDisplayManager : NavAppComponentsDisplayManager

Default implementation for NavAppComponentsDisplayManager.

Properties

navAppClientTag

val FrontendViewModel<*>.navAppClientTag: String

This is a convenience util for generating a client tag for NavApp. The client tag can be passed to NavAppComponentsProvider.getGlobalComponent for logging purposes.

Functions

getDisplayManagerInstanceAndConfigure

@IviExperimental(reasons = [])

fun Frontend.getDisplayManagerInstanceAndConfigure(componentTags: Set<ComponentTag>): FrontendNavAppComponentsDisplayManager

Returns a FrontendNavAppComponentsDisplayManager configured for the given componentTags, tied to the Frontend.