platform_navigation_api_service_trip/com.tomtom.ivi.platform.navigation.api.service.trip/TripService

TripService

interface TripService
Content copied to clipboard

Provides an interface to perform operations on a Trip. For example: planning a Trip, canceling a Trip and navigating a Trip.

Types

Link copied to clipboard
object Companion
Content copied to clipboard
Link copied to clipboard
interface TripPlanCompletionListener
Content copied to clipboard

Trip plan completion listener which receives the planned TripId and whether a TripPlanError occurred. The TripId can be null in case of errors.

Properties

Link copied to clipboard
abstract val activeTripId: TripId?
Content copied to clipboard

The activeTripId is the ID of the Trip currently being navigated. A Trip might have multiple routes (i.e. multiple paths to get from departure to destination).

Link copied to clipboard
abstract val activeTripPlan: TripPlan?
Content copied to clipboard

TripPlan contains the parameters for planning a Trip (i.e. departure and destination coordinate).

Functions

Link copied to clipboard
abstract suspend fun cancelActiveTrip()
Content copied to clipboard

Stops navigating the currently activeTrip.

Link copied to clipboard
abstract suspend fun planTripFromTo(departure: Place, destination: Place)
Content copied to clipboard

Plan a Trip from a departure to a destination.

Link copied to clipboard
abstract suspend fun planTripTo(destination: Place)
Content copied to clipboard

Plan a Trip from the current location to a destination.