platform_frontend_api_common_frontend/com.tomtom.ivi.platform.frontend.api.common.frontend/FrontendContext

FrontendContext

interface FrontendContext : IviInstanceIdProvider

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

A FrontendContext can only be used by a single Frontend instance.

Properties

abstract val applicationContext: Context

The Android context of the single, global Application object within a process. This context is tied to the lifetime of the process, not an Activity or another component.

iviInstanceId

abstract override val iviInstanceId: IviInstanceId

The ID of the IVI instance in which the Frontend is presented.

iviServiceProvider

abstract val iviServiceProvider: IviInstanceBoundIviServiceProvider

Provides access to services.

staticConfigurationProvider

abstract val staticConfigurationProvider: StaticConfigurationProvider

Allows retrieving the values of static configurations, given a configuration key.

Functions

isPanelTypeAvailableToFrontend

abstract fun isPanelTypeAvailableToFrontend(panelType: KClass<out AnyPanel>): Boolean

Returns whether Panels of type panelType can be added to the Frontend. For a Panel type to be available, it must be specified in a Frontend's FrontendMetadata.availablePanelTypes.

isPanelTypeSupportedBySystemUi

abstract fun isPanelTypeSupportedBySystemUi(panelType: KClass<out AnyPanel>): Boolean

Returns whether Panels of type panelType can be presented to the user by the system UI that owns the Frontend.