platform_framework_api_ipc_iviservice/com.tomtom.ivi.platform.framework.api.ipc.iviservice/IviServiceBase

IviServiceBase

abstract class IviServiceBase<P : Any, PO : IviServicePropertiesObserver> constructor(iviServiceHostContext: IviServiceHostContext) : LifecycleOwner

Base for the generated base classes of IVI Services.

This class is parameterized by the properties class P and the properties observer interface PO of an IVI service.

Parameters

iviServiceHostContext

The IVI service host context.

Constructors

fun IviServiceBase(iviServiceHostContext: IviServiceHostContext)

Types

object Companion

Properties

val context: Context

The Android context of the service.

dynamicConfigurationProvider

val dynamicConfigurationProvider: DynamicConfigurationProvider

Allows retrieving the values of dynamic configurations using a configuration key.

isLogStatusWhenNotReadyEnabled

open val isLogStatusWhenNotReadyEnabled: LiveData<Boolean>

Can be overridden to disable logging status information when serviceReady is false. The status will be logged every logStatusWhenNotReadyInterval milliseconds.

val iviInstanceId: IviInstanceId?

The IVI instance ID of the service host. null if the IVI service is a global IVI service.

iviServiceProvider

val iviServiceProvider: IviServiceProvider

IVI service provider instance.

logStatusWhenNotReadyInterval

open val logStatusWhenNotReadyInterval: Duration

Interval in milliseconds in between logging the service status info when serviceReady is false and when isLogStatusWhenNotReadyEnabled is true.

propertiesObservers

abstract val propertiesObservers: LifecycleAwareListeners<PO>

Allows the registration of properties observer.

abstract val serviceId: IviServiceId

IviServiceId of the IVI Service. Implemented by the generated <Interface>Base class.

serviceLifecycleState

val serviceLifecycleState: LiveData<Lifecycle.State>

The service lifecycle state.

staticConfigurationProvider

val staticConfigurationProvider: StaticConfigurationProvider

Allows retrieving the values of static configurations using a configuration key.

Functions

appendStatusInfo

abstract fun appendStatusInfo(stringBuilder: StringBuilder)

Called to log the status of the service.

createConnectionFactory

abstract fun createConnectionFactory(ipcMessageDispatchFailureListener: IpcMessageDispatchFailureListener): IviServiceConnectionFactory

Creates a connection factory for this IVI service interface.

override fun getLifecycle(): Lifecycle

initializePropertyObserver

abstract fun initializePropertyObserver(propertiesObserver: PO)

Initializes the given propertiesObserver with all properties values.

@CallSuper

open fun onCreate()

Called by the system when the service is created.

@CallSuper

open fun onDestroy()

Called when the service is being destroyed.