Package com.tomtom.ivi.platform.companionapp.api.service.companionapp

The mobile companion app service API package.

Companion app service

The companion app service is an IVI service that is responsible for the TomTom Digital Cockpit side of the connection between this platform and a companion app.

This service does not provide any API calls. Once started, it listens for incoming commands from the companion app and responds to them.

Using companion app service API

To use the companion app service, add a dependency to the CompanionAppService to your gradle file:

dependencies {
    implementation("com.tomtom.ivi.platform:platform_companionapp_api_service_companionapp:+")
}

In order to start the CompanionAppService, you need to first get a CompanionAppServiceApi instance by calling the companion function CompanionAppService.createApi(...).

val companionAppService = CompanionAppService.createApi(lifecycleOwner, iviServiceProvider)