Package com.tomtom.ivi.platform.frontend.api.common.frontend

Types

Link copied to clipboard
abstract class Frontend(val frontendContext: FrontendContext) : LifecycleOwner

The base class for Frontends in the IVI system.

Link copied to clipboard
abstract class FrontendBuilder

Builder class for Frontends.

Link copied to clipboard
interface FrontendContext : IviInstanceIdProvider

The entry point for a single Frontend to communicate with the rest of the system.

Link copied to clipboard
enum FrontendCreationPolicy : Enum<FrontendCreationPolicy>

Describes when the framework should create a Frontend.

Link copied to clipboard
interface FrontendExtension

Interface of all frontend extensions.

Link copied to clipboard
data class FrontendMetadata(    val id: FrontendMetadataId,     val creationPolicy: FrontendCreationPolicy = FrontendCreationPolicy.CREATE_FRONTEND_AFTER_STARTUP,     val launchMenuItem: MenuItem? = null,     val frontendExtensions: Collection<FrontendExtension> = emptyList(),     val availablePanelTypes: PanelTypeSet = PLATFORM_PANEL_TYPES,     val frontendBuilderFactory: () -> FrontendBuilder)

Encapsulates metadata describing a Frontend.

Link copied to clipboard
data class FrontendMetadataId(val id: String)

A unique FrontendMetadata identifier per IviInstanceId.

Link copied to clipboard
abstract class IviFragment<P : AnyPanel, VM : FrontendViewModel<P>> : Fragment, HasDefaultViewModelProviderFactory

A base class for fragments that contain the contents of frontend panels. Typical IVI fragments are responsible for creating a layout and linking it to a ViewModel. The viewModelClass is responsible for the business logic and the state of a fragment. This is because, unlike fragments, ViewModels are persistent across configuration changes.

Link copied to clipboard
interface OnBackPressedConsumer

An interface for components capable of consuming hardware back button presses.

Link copied to clipboard
class OnBackPressedConsumerOwner : OnBackPressedConsumer

A helper class for managing multiple OnBackPressedConsumers.

Functions

Link copied to clipboard
fun Sequence<OnBackPressedConsumer>.onBackPressed(): Boolean

Propagates a back press event across a list of consumers. This starts by offering the event to the first consumer and passing it on to the next, until a consumer returns true.