navigation:engine/com.tomtom.sdk.navigation

Package com.tomtom.sdk.navigation

Types

ActiveRoute

data class ActiveRoute(val routePlan: RoutePlan, val betterProposal: RoutePlan?)

ActiveRoute class contains an active RoutePlan, and a better proposal RoutePlan. Better proposal RoutePlan can be null.

InstructionPhase

@JvmInline

value class InstructionPhase(val phase: Int)

Represents instruction triggering phase.

NavigationConfiguration

data class NavigationConfiguration constructor( val context: Context, val apiKey: String, val locationEngine: LocationEngine, val routingApi: RoutingApi, val mapMatchingEngine: MapMatchingEngine = TomTomMapMatchingEngine(context), val dataStoreUpdateContextEngine: DataStoreUpdateContextEngine? = null, val guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createGuidanceEngine( context, GuidanceEngineOptions() ), val routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(context), val routeProgressCalculationEngine: RouteProgressCalculationEngine = RouteProgressCalculationEngineFactory.create(), val locationContextProviderEngine: LocationContextProviderEngine = TomTomLocationContextProviderEngine( context ), val arrivalDetectionEngine: ArrivalDetectionEngine = TomTomArrivalDetectionEngine(), val routeReplanningEngine: RouteReplanningEngine = RouteReplanningEngineFactory.create( routingApi ), 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 telemetryApi: TelemetryApi? = null)

Configuration of the Navigation SDK.

NavigationController

interface NavigationController : Disposable

Responsible for interacting with and customizing a navigation.

NavigationError

open class NavigationError

Represents an error raised when something went wrong in navigation.

NavigationHistorySnapshot

data class NavigationHistorySnapshot(val visitedRouteCoordinates: List<RouteCoordinate>)

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

NavigationOptions

data class NavigationOptions(val activeRoutePlan: RoutePlan?)

NavigationOptions class contains an active RoutePlan, and a list of alternative RoutePlan. Active RoutePlan can be null.

NavigationSnapshot

data class NavigationSnapshot( val activeRoute: ActiveRoute?, val alternativeRoutes: List<RoutePlan>, val routes: List<Route>, val routeCreationTime: Long, val isGuidanceAvailable: Boolean, val location: GeoLocation, val mapMatchingResult: MapMatchingResult, val locationContext: LocationContext, val routeProgress: RouteProgress, val history: NavigationHistorySnapshot, val hasRouteDeviated: Boolean, val hasReachedDestination: Boolean, val currentInstructionId: UniqueId?, val proposedRoute: ReplannedRoute?, val waypointSnapshot: NavigationWaypointSnapshot)

Read-only snapshot of the current navigation session.

NavigationStartedCallback

interface NavigationStartedCallback

Callback used in starting navigation. Starting navigation is asynchronous, and the callback methods will be called after the operation is finished, whether it succeeds or not.

NavigationStartError

class NavigationStartError(val message: String) : NavigationError

Returned when an error occurred during initialization of the underlying services.

NavigationWaypointSnapshot

data class NavigationWaypointSnapshot(val nextWaypoint: Waypoint?, val numberOfVisitedWaypoints: Int)

Read-only snapshot of the waypoints in the current navigation session.

OnDestinationReachedListener

fun interface OnDestinationReachedListener

Used to inform caller about the arrival at the destination.

OnErrorListener

fun interface OnErrorListener

Used to inform caller about errors during navigating. Can be registered with TomTomNavigation.addOnNavigationErrorListener.

OnGuidanceUpdateListener

interface OnGuidanceUpdateListener

Used to inform caller about guidance.

OnLaneGuidanceUpdateListener

interface OnLaneGuidanceUpdateListener

Used to inform caller about lane guidance.

OnLocationContextUpdateListener

fun interface OnLocationContextUpdateListener

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

OnLocationMatchedListener

fun interface OnLocationMatchedListener

Used to inform caller that current location has been matched to the road.

OnLocationPredictionsGeneratedListener

fun interface OnLocationPredictionsGeneratedListener

Used to inform caller that new predictions has been generated.

OnNavigationStartedListener

fun interface OnNavigationStartedListener

Used to inform caller that navigation has been started.

OnProgressUpdateListener

fun interface OnProgressUpdateListener

Used to inform caller about progress on Route.

OnReplannedRouteProposedListener

interface OnReplannedRouteProposedListener

Informs about new ReplannedRoute when ContinuousReplanningMode is set to ContinuousReplanningMode.MANUAL or ContinuousReplanningMode.UNREACHABLE_ONLY in NavigationConfiguration.

OnRouteDeviationListener

fun interface OnRouteDeviationListener

Used to inform caller about getting off the route.

OnRouteUpdatedListener

fun interface OnRouteUpdatedListener

Used to inform caller that the route has been updated.

OnWaypointVisitedListener

fun interface OnWaypointVisitedListener

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

PublicPreviewNavigationApi

annotation class PublicPreviewNavigationApi

RoutePlan

data class RoutePlan(val route: Route, val routePlanningOptions: RoutePlanningOptions)

Options to specify all required parameters for a single navigation session.

RouteUpdatedCallback

interface RouteUpdatedCallback

Callback used in the update function. Route update is asynchronous and the callback methods will be called once the update is finished, whether it succeeds or not.

RouteUpdateError

class RouteUpdateError(val message: String) : NavigationError

Returned when an error occurred while updating the Route.

RouteUpdateReason

enum RouteUpdateReason : Enum<RouteUpdateReason>

Specifies the reason for updating the current route.

TomTomNavigation

class TomTomNavigation : NavigationController

Responsible for interacting with and customizing a navigation.