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

FrontendContext

interface FrontendContext : IviInstanceIdProvider
Content copied to clipboard

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

Link copied to clipboard
abstract override val iviInstanceId: IviInstanceId
Content copied to clipboard

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

Link copied to clipboard
abstract val iviServiceProvider: IviInstanceBoundIviServiceProvider
Content copied to clipboard

Provides Frontends with access to services.

Link copied to clipboard
abstract val staticConfigurationProvider: StaticConfigurationProvider
Content copied to clipboard

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

Functions

Link copied to clipboard
abstract fun isPanelTypeAvailableToFrontend(panelType: KClass<out AnyPanel>): Boolean
Content copied to clipboard

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.

Link copied to clipboard
abstract fun isPanelTypeSupportedBySystemUi(panelType: KClass<out AnyPanel>): Boolean
Content copied to clipboard

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