Package-level declarations

  • TomTomNavigation: The primary interface for controlling the navigation process. It offers comprehensive methods to manage lifecycle events, set active routes, and customize navigation experiences.

  • NavigationOptions: Provides details for starting a navigation session with a specific route.

  • NavigationState: Represents different states of navigation.

Listeners:

This module also supports a variety of listeners to track changes and updates throughout the navigation session, including:

Types

Link copied to clipboard

Used to inform the caller that the active route has been changed. The active route is the only route that is being followed for which the navigation provides guidance.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class ConfigurationSnapshot

Snapshot of the current navigation configuration.

Link copied to clipboard

Used to inform the caller that they have arrived at the destination.

Link copied to clipboard

Used to inform the caller that the guidance information has been updated. This interface provides listeners when there are changes in instructions, announcements, and distance to next instruction.

Link copied to clipboard

Used to inform the caller that the horizon information has been updated.

Link copied to clipboard

Used to inform the caller that lane guidance information has been updated.

Link copied to clipboard

Used to inform the caller that the navigation language has been changed.

Link copied to clipboard

Used to inform the caller that the location context has been updated.

Link copied to clipboard

Used to inform the caller that a new location has been map-matched.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class LocationSnapshot

Snapshot of the current location information during navigation.

Link copied to clipboard

Provides a way to read and change the dynamic properties of TomTomNavigation.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
interface NavigationEngineRegistry : AutoCloseable

Provides access to currently registered engines and allows updating them.

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

Defines parameters required to start a navigation session.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class NavigationSnapshot

Snapshot of the current navigation session.

Link copied to clipboard

Specifies the current navigation state of the TomTomNavigation object.

Link copied to clipboard

Used to inform the caller that the NavigationState has been changed.

Link copied to clipboard

Used to inform the caller that the progress on the active Route has been updated.

Link copied to clipboard
fun interface RouteAddedListener

Used to inform the caller that a route has been added to the navigation session.

Link copied to clipboard
abstract class RouteAddedReason

Reason why the route was added to the navigation.

Link copied to clipboard
class RoutePlan(val route: Route, val routePlanningOptions: RoutePlanningOptions)

Defines parameters required for a single route in navigation session.

Link copied to clipboard
fun interface RouteRemovedListener

Used to inform the caller that a route has been removed from the navigation session.

Link copied to clipboard
abstract class RouteRemovedReason

Reason the route was removed from navigation.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class RouteSnapshot

Snapshot of the route.

Link copied to clipboard

Used to inform the caller that the route tracking stage has been updated.

Link copied to clipboard
fun interface RouteUpdatedListener

Used to inform the caller that a route has been updated.

Link copied to clipboard
fun interface RouteUpdatedListener2

Used to inform the caller that a route has been updated.

Link copied to clipboard
abstract class RouteUpdatedReason

Specifies the reason for updating the current route.

Link copied to clipboard

The TomTomNavigation interface serves as the primary interface for controlling the navigation process. It provides a comprehensive set of functionalities for managing and customizing a navigation session.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class TripSnapshot

Snapshot that contains information about the trip.

Link copied to clipboard
abstract class UnitSystemType : Parcelable

Defines types of UnitSystem handling.

Link copied to clipboard

Used to inform the caller that the WaypointState has been changed during navigation.

Properties

Link copied to clipboard
@get:RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
val NavigationSnapshot.currentActiveRoutePlanningOptions: RoutePlanningOptions

Current RoutePlanningOptions that can be used for replanning the active route from the current position.

Functions

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun RoutePlanningOptions.addItineraryPoint(itineraryPoint: ItineraryPoint): RoutePlanningOptions

Adds the given itineraryPoint to the Itinerary. It is added as the last waypoint in the Itinerary.waypoints list.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun RoutePlanningOptions.addItineraryPoint(itineraryPoint: ItineraryPoint, itineraryPointBefore: ItineraryPoint): RoutePlanningOptions

Adds the given itineraryPoint to the Itinerary.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun RoutePlanningOptions.removeItineraryPoint(itineraryPoint: ItineraryPoint): RoutePlanningOptions

Removes the given itineraryPoint from the Itinerary.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun RoutePlanningOptions.skipRouteStop(routeStop: RouteStop): RoutePlanningOptions

Skips the given RouteStop. This operation is a combination of: