Package-level declarations

Types

Link copied to clipboard

Used to inform caller about the arrival at the destination.

Link copied to clipboard

Used to inform caller about guidance.

Link copied to clipboard

Used to inform caller that a new horizon snapshot is available.

Link copied to clipboard

Used to inform caller about lane guidance.

Link copied to clipboard

Used to inform caller that the navigation language has changed.

Link copied to clipboard

Used to inform caller about detailed information in current location on road.

Link copied to clipboard

Used to inform caller that new location was map matched.

Link copied to clipboard
data class NavigatedRoutes(val activeRoute: ActiveRoute, val alternativeRoutes: List<RoutePlan> = emptyList())

Aggregate of routes present in the navigation session, arranged by their roles.

Link copied to clipboard
data class NavigationConfiguration constructor(val context: Context, val apiKey: String, val locationProvider: LocationProvider, val dataStoreSelectionEngine: DataStoreSelectionEngine? = null, val routeReplanner: RouteReplanner, val mapMatchingEngine: MapMatchingEngine = LegacyMapMatchingEngineFactory.create(context), val horizonEngine: HorizonEngine? = null, val guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createStaticGuidanceEngine( context, GuidanceEngineOptions() ), val routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(context), val routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), val routeProjectionEngine: RouteProjectionEngine? = null, val locationContextProviderEngine: LocationContextProviderEngine = LegacyLocationContextProviderEngineFactory.create(context), val arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), val routeReplanningEngine: RouteReplanningEngine = RouteReplanningEngineFactory.create(routeReplanner), val replanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(), val continuousReplanningMode: ContinuousReplanningMode = ContinuousReplanningMode.Manual, val deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, val maintainRoutesMode: MaintainRoutesMode = MaintainRoutesMode.ActiveRouteOnly, val apiPath: Uri? = null, val apiKeyParamName: String? = null, val navigationProcessingThrottle: Duration = DEFAULT_LOCATION_UPDATE_THROTTLE, val telemetry: Telemetry? = null, val vehicleProvider: VehicleProvider = DefaultVehicleProvider())

Configuration of the Navigation SDK.

Link copied to clipboard

Provides access to current registered engines and allows updating them.

Link copied to clipboard
abstract class NavigationFailure

Represents an failure raised when something went wrong in navigation.

Link copied to clipboard

Used to inform caller about failures during navigating. Can be registered with TomTomNavigation.addNavigationFailureListener.

Link copied to clipboard
data class NavigationHistorySnapshot(val visitedRoutePoints: List<RoutePoint>)

Navigation history is a structure containing info regarding the passed history of the route, such as visited polyline points (route points).

Link copied to clipboard
data class NavigationOptions(val activeRoutePlan: RoutePlan)

NavigationOptions encapsulate options for starting navigation.

Link copied to clipboard

Used to inform caller that navigation has been started.

Link copied to clipboard

Used to inform caller about progress on Route.

Link copied to clipboard
Link copied to clipboard

Used to inform caller about getting off the route.

Link copied to clipboard
fun interface RoutesChangedListener

Used to inform the caller that the set of routes in the navigation session. has changed. Can be registered with TomTomNavigation.addRoutesChangedListener.

Link copied to clipboard
fun interface RouteUpdatedListener

Used to inform caller that the route has been updated.

Link copied to clipboard

Specifies the reason for updating the current route.

Link copied to clipboard

Responsible for interacting with and customizing a navigation.

Link copied to clipboard

Responsible for creating default implementation of TomTomNavigation.

Link copied to clipboard
abstract class UnitSystemType

Defines types of UnitSystem handling.

Link copied to clipboard

Used to inform a caller that the waypoint has been visited.