Package-level declarations

The companion app communications service API package.

Companion app communications service

The companion app communications service is a discoverable IVI service. It is the entry point for the companion app's communications features.

All services that implement the CompanionAppCommunicationsService will be automatically discovered and started.

Note: No API calls are provided by this service API.

Using companion app communications service API

To use the companion app communications service, add a dependency to the CompanionAppCommunicationsService to your Gradle file:

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

To start the companion app communications service, you need to call the companion function:

CompanionAppCommunicationsService.createApis(lifecycleOwner, iviServiceProvider)

Another service is able to make use of this discoverable service by inheriting from CompanionAppCommunicationsServiceBase.

class ExampleService(
    iviServiceHostContext: IviServiceHostContext,
    serviceIdProvider: IviDiscoverableServiceIdProvider
) : CompanionAppCommunicationsServiceBase(iviServiceHostContext, serviceIdProvider) {
  // ...
}