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 the client about horizon updates.

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: <Error class: unknown class>, val alternativeRoutes: List<<Error class: unknown class>> = emptyList())

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

Link copied to clipboard
data class NavigationConfiguration constructor(val context: <Error class: unknown class>, val apiKey: String, val locationProvider: <Error class: unknown class>, val dataStoreSelectionEngine: DataStoreSelectionEngine? = null, val routeReplanner: <Error class: unknown class>, val mapMatchingEngine: <Error class: unknown class> = LegacyMapMatchingEngineFactory.create(context), val horizonEngine: <Error class: unknown class>? = null, val guidanceEngine: <Error class: unknown class> = GuidanceEngineFactory.createStaticGuidanceEngine( context, GuidanceEngineOptions() ), val routeTrackingEngine: <Error class: unknown class> = RouteTrackingEngineFactory.create(context), val routeProgressEngine: <Error class: unknown class> = RouteProgressEngineFactory.create(), val routeProjectionEngine: <Error class: unknown class>? = null, val locationContextProviderEngine: <Error class: unknown class> = LegacyLocationContextProviderEngineFactory.create(context), val arrivalDetectionEngine: <Error class: unknown class> = DefaultArrivalDetectionEngineFactory.create(), val routeReplanningEngine: <Error class: unknown class> = RouteReplanningEngineFactory.create(routeReplanner), val replanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(), val betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.Manual, val deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, val maintainRoutesMode: MaintainRoutesMode = MaintainRoutesMode.ActiveRouteOnly, val apiPath: <Error class: unknown class>? = getApiUriBasePath(), val apiKeyParamName: String? = null, val navigationProcessingThrottle: <Error class: unknown class> = DEFAULT_LOCATION_UPDATE_THROTTLE, val telemetry: <Error class: unknown class>? = null, val vehicleProvider: <Error class: unknown class> = 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<<Error class: unknown class>>)

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: <Error class: unknown class>)

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
value class RouteUpdateReason

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 arrival state has changed.