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

Encapsulates metadata describing a Frontend.

FrontendMetadataBuildConfigExtension

@IviInternal

data class FrontendMetadataBuildConfigExtension(val frontendMetadata: Map<IviInstanceId, Collection<FrontendMetadata>> = emptyMap()) : IviBuildConfigExtension

An IviBuildConfigExtension containing the FrontendMetadata, generated at build-time.

FrontendMetadataId

data class FrontendMetadataId(val id: String)

A unique FrontendMetadata identifier per IviInstanceId.

IviFragment

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.

IviFragmentId

class IviFragmentId

An IviFragment identifier.

IviOnBackPressedCallback

interface IviOnBackPressedCallback

An interface for components that handle hardware back button presses.

IviOnBackPressedCallbackOwner

interface IviOnBackPressedCallbackOwner

An interface for components that have an IviOnBackPressedCallback, which can handle hardware back button presses.

IviOnBackPressedDispatcher

class IviOnBackPressedDispatcher : IviOnBackPressedCallback

An IviOnBackPressedCallback that can dispatch on back presses to other IviOnBackPressedCallbacks. It is disabled by default and enabled when any of added callbacks are enabled. The last added callback that is currently enabled is called to handle the back press.

PanelExitAnimationListener

interface PanelExitAnimationListener

Interface for views that need to be notified when the exit animation is started on the panels, which display them.

Properties

frontendMetadataBuildConfigExtension

@IviInternal

val IviBuildConfig.frontendMetadataBuildConfigExtension: FrontendMetadataBuildConfigExtension

Returns the FrontendMetadataBuildConfigExtension from the IviBuildConfig instance.

frontendMetadataBuildConfigExtensionId

@IviInternal

val frontendMetadataBuildConfigExtensionId: IviBuildConfigExtensionId<FrontendMetadataBuildConfigExtension>

Identifier for the FrontendMetadataBuildConfigExtension.

Functions

toIviOnBackPressedCallback

fun <T : IviOnBackPressedCallbackOwner> List<T>.toIviOnBackPressedCallback(): LiveData<IviOnBackPressedCallback>

Combine a list of IviOnBackPressedCallbackOwners into one IviOnBackPressedCallback.