Release Notes
Version 2.7.2 - 10/11/2026
Discover the improvements and new features included in the following version.
Share your thoughts on this release by using the feedback button located at the bottom of the page.
For more in-depth documentation, check the API ReferenceGeneral
Fixes
- Fix online requests failing after the device wakes from deep sleep or comes back online. Online search could stop working until the app was restarted, and map data for the current area was not downloaded again after going back online, so information such as speed limits stayed missing. Network requests already in progress are no longer canceled when connectivity returns.
- Fix hybrid search, route planning and range calculation taking 10 to 20 seconds to return a result when the device could not resolve the server’s host name. DNS resolution for these requests now times out after 5 seconds, so the onboard result is returned promptly.
Removals
- Remove
com.tomtom.sdk.navigation:uiandcom.tomtom.sdk.search:uimodules. Both modules were deprecated as part of the2.1.0release. If your project still depends on either module, continue using the last published version, or migrate to the equivalent building blocks in the open-source NavSDK example application TomTom published as a replacement.
Common
Updates
- Restore
com.tomtom.sdk.vehicle.VehicleProviderandcom.tomtom.sdk.vehicle.VehicleProviderFactoryto their previous non-deprecated state. No action is required. com.tomtom.sdk.location.DefaultLocationProviderFactory.create(Context, CoroutineDispatcher, LocationProviderConfig)is no longer deprecated.
Fixes
- Fix a crash (
NetworkOnMainThreadException) that occurred on network connectivity changes (for example, switching from mobile data to Wi-Fi) when the app provided a custom network-state notifier that delivered callbacks on the main thread. - Store the default cache directory for
com.tomtom.sdk.common.configuration.CacheStorageConfiguration.directoryPathunder the app’s cache directory (context.cacheDir) instead of internal storage (context.filesDir), and remove any cache data left behind under the previous location. - Fix the map style being downloaded again at the start of every navigation session even when it was already cached, which used about 0.45 MB of extra mobile data per session. The SDK now checks whether cached data has changed before downloading it again.
- The SDK no longer crashes with a
ConcurrentModificationExceptionwhen it sends a request while SDK metadata properties are set or removed on another thread.
Removals
- Remove deprecated
com.tomtom.sdk.common.TaskHandlerclass.
Data Management
Updates
-
The following APIs for onboard manual map management are now available in General Availability:
com.tomtom.sdk.datamanagement.nds.NdsStore.obtainRegionUpdater()com.tomtom.sdk.datamanagement.nds.region.RegionUpdatercom.tomtom.sdk.datamanagement.nds.region.RegionInfoUpdateListenercom.tomtom.sdk.datamanagement.nds.region.Regionandcom.tomtom.sdk.datamanagement.nds.region.Region.Idcom.tomtom.sdk.datamanagement.nds.region.RegionStatecom.tomtom.sdk.datamanagement.nds.region.RegionStateInfocom.tomtom.sdk.datamanagement.nds.region.RegionStructurecom.tomtom.sdk.datamanagement.nds.region.RegionInstallStatecom.tomtom.sdk.datamanagement.nds.region.RegionUpdateStatecom.tomtom.sdk.datamanagement.nds.region.RegionDataInfocom.tomtom.sdk.datamanagement.nds.region.RegionOperation,com.tomtom.sdk.datamanagement.nds.region.RegionOperation.Typeandcom.tomtom.sdk.datamanagement.nds.region.RegionOperation.Sourcecom.tomtom.sdk.datamanagement.nds.region.RegionOperationStatus,com.tomtom.sdk.datamanagement.nds.region.RegionOperationStatus.Progressandcom.tomtom.sdk.datamanagement.nds.region.RegionOperationStatus.Completedcom.tomtom.sdk.datamanagement.nds.region.RegionQueryCallbackcom.tomtom.sdk.datamanagement.nds.region.RegionSizeQueryCallbackcom.tomtom.sdk.datamanagement.nds.region.DownloadedRegionDataAction
Use
com.tomtom.sdk.datamanagement.nds.NdsStore.obtainRegionUpdater()to obtain acom.tomtom.sdk.datamanagement.nds.region.RegionUpdater, and register acom.tomtom.sdk.datamanagement.nds.region.RegionInfoUpdateListenerto observe region structure, state and operation status changes.
Fixes
- The app no longer crashes when the offline map store is closed while an offline search query, such as a POI details lookup, is still running. The store now waits for the running query to finish before it releases the map.
- The SDK no longer crashes in rare cases when
com.tomtom.sdk.datamanagement.nds.NdsStore.close()is called while an offline map update is releasing its map connections. - The SDK no longer crashes with an
IllegalStateExceptionwhencom.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.close()is called while a background map query is still finishing. - Fix SDK initialization failing with a “map directory is not writable” error on some devices when using an online-only configuration, even though no onboard map storage is used.
Deprecations
-
com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.findRegionsAroundPosition(GeoPoint, Distance, Callback<RegionsAroundPosition, MapUpdateError>)is deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.findRegionsAroundPosition(GeoPoint, Distance, RegionQueryCallback)instead; obtain theRegionUpdaterwithcom.tomtom.sdk.datamanagement.nds.NdsStore.obtainRegionUpdater(). -
com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.findRegionsAlongPolyline(List<GeoPoint>, Distance, Callback<RegionsAlongPolyline, MapUpdateError>)is deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.findRegionsAlongPolyline(List<GeoPoint>, Distance, RegionQueryCallback)instead. -
com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.calculateUninstallSize(Set<RegionGraphNodeId>, Callback<Memory, MapUpdateError>)is deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.calculateUninstallSize(Set<Region.Id>, RegionSizeQueryCallback)instead. -
com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.scheduleMapOperations(List<MapOperation>)is deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.download(List<Region.Id>)andcom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.delete(List<Region.Id>)instead. -
com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.cancelAllMapOperations(List<RegionGraphNodeId>)is deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.cancelOperations(Set<Region.Id>, DownloadedRegionDataAction)instead. -
com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.addRegionGraphListener(RegionGraphListener)andcom.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.removeRegionGraphListener(RegionGraphListener)are deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.addRegionInfoUpdateListener(RegionInfoUpdateListener)andcom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.removeRegionInfoUpdateListener(RegionInfoUpdateListener)instead. -
com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.setUpdatesEnabled(Boolean)is deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.NdsStore.setUpdatesEnabled(Boolean)instead. -
The
com.tomtom.sdk.datamanagement.nds.update.compositeregion.CompositeRegionsUpdater(NdsStoreUpdater)constructor is deprecated and will be removed 6 months after the next release. Use thecom.tomtom.sdk.datamanagement.nds.update.compositeregion.CompositeRegionsUpdater(NdsStore)constructor instead. -
com.tomtom.sdk.datamanagement.nds.update.RegionGraphListeneris deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionInfoUpdateListener, registered withcom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.addRegionInfoUpdateListener(RegionInfoUpdateListener), instead. -
com.tomtom.sdk.datamanagement.nds.update.MapOperationis deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.download(List<Region.Id>)andcom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.delete(List<Region.Id>)instead; scheduled operations are reported ascom.tomtom.sdk.datamanagement.nds.region.RegionOperation. -
com.tomtom.sdk.datamanagement.nds.update.AutomaticMapUpdateFailureListeneris deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionInfoUpdateListenerinstead; automatic-update failures are reported throughonOperationStatusesChangedascom.tomtom.sdk.datamanagement.nds.region.RegionOperationStatus.Completedwith a non-null error, for operations whose source iscom.tomtom.sdk.datamanagement.nds.region.RegionOperation.Source.AutomaticUpdates. -
com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.addAutomaticMapUpdateFailureListener(AutomaticMapUpdateFailureListener)andcom.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.removeAutomaticMapUpdateFailureListener(AutomaticMapUpdateFailureListener)are deprecated and will be removed 6 months after the next release. Usecom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.addRegionInfoUpdateListener(RegionInfoUpdateListener)andcom.tomtom.sdk.datamanagement.nds.region.RegionUpdater.removeRegionInfoUpdateListener(RegionInfoUpdateListener)instead; obtain theRegionUpdaterwithcom.tomtom.sdk.datamanagement.nds.NdsStore.obtainRegionUpdater(). -
The composite-region API for group-level offline map management is deprecated and will be removed 6 months after the next release. Use the
RegionUpdater, obtained withNdsStore.obtainRegionUpdater(), instead. Its unifiedRegionmodel covers the whole region hierarchy, so country or continent level regions can be downloaded and deleted directly:CompositeRegionsUpdater: useRegionUpdater.CompositeRegion: useRegion.CompositeRegionGraph: useRegionStructure.CompositeRegionId: useRegion.Id.CompositeRegionListenerandCompositeRegionsUpdater.addCompositeRegionListener()/removeCompositeRegionListener(): useRegionInfoUpdateListener, registered withRegionUpdater.addRegionInfoUpdateListener().onStructureChanged()replacesonCompositeRegionGraphChanged().onStatesChanged()andonOperationStatusesChanged()replaceonCompositeRegionStatesChanged().CompositeRegionOperationandCompositeRegionsUpdater.scheduleMapOperations(): useRegionUpdater.download()andRegionUpdater.delete().CompositeRegionsUpdater.cancelAllMapOperations(): useRegionUpdater.cancelOperations().CompositeRegionsUpdater.calculateUninstallSize(): useRegionUpdater.calculateUninstallSize().CompositeRegionsUpdater.findCompositeRegions(): query theRegionStructureinstead.CompositeRegionState: useRegionStatefor the install and update state andRegionOperationStatusfor running and completed operations.CompositeRegionStatesData: useRegionStateInfo.CurrentCompositeRegionOperation: useRegionOperationStatus.Progress.
-
The region-graph API of the offline map updater is deprecated and will be removed 6 months after the next release. Use the
RegionUpdatermodel instead:RegionGraph: useRegionStructure.RegionGraphNode: useRegion.RegionGraphNodeId: useRegion.Id.RegionGraphNodeState: useRegionStatefor the install and update state andRegionOperationStatusfor running and completed operations.InstallState: useRegionInstallState.UpdateState: useRegionUpdateState.UpdateInfo: useRegionUpdater.calculateDownloadSize()to query the download size of an update.CurrentMapOperation: useRegionOperationStatus.Progress.CompletedMapOperation: useRegionOperationStatus.Completed.MapOperationType: useRegionOperation.Type.RegionsAroundPositionandRegionsAlongPolyline:RegionUpdater.findRegionsAroundPosition()andRegionUpdater.findRegionsAlongPolyline()report the found regions directly as a set ofRegion.Id.
Removals
-
Remove the following previously deprecated data-management APIs:
com.tomtom.sdk.datamanagement.datasource.DataSourcecom.tomtom.sdk.datamanagement.datastore.ActiveRouteUpdatablecom.tomtom.sdk.datamanagement.datastore.PositionUpdatablecom.tomtom.sdk.datamanagement.datastore.StoreAccesscom.tomtom.sdk.datamanagement.datastore.StoreAccessProvidercom.tomtom.sdk.datamanagement.datastore.UpdatableDataStorecom.tomtom.sdk.datamanagement.locationdecoder.DataVersioncom.tomtom.sdk.datamanagement.locationdecoder.DecodedLocationcom.tomtom.sdk.datamanagement.locationdecoder.DecodingCoveragecom.tomtom.sdk.datamanagement.locationdecoder.DecodingFailurecom.tomtom.sdk.datamanagement.locationdecoder.SegmentMatchStatuscom.tomtom.sdk.datamanagement.hybridnavigationdata.HybridNavigationDataStore.updatePosition(GeoPoint)com.tomtom.sdk.datamanagement.hybridnavigationdata.HybridNavigationDataStore.updateActiveRoute(List<GeoPoint>)com.tomtom.sdk.datamanagement.navigationtile.NavigationTileStore.updatePosition(GeoPoint)com.tomtom.sdk.datamanagement.navigationtile.NavigationTileStore.updateActiveRoute(List<GeoPoint>)com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.updatePosition(GeoPoint)com.tomtom.sdk.datamanagement.nds.update.NdsStoreUpdater.updateActiveRoute(List<GeoPoint>)com.tomtom.sdk.datamanagement.nds.NdsStoreConfiguration.copy(File, File?, NdsStoreAccessPermit?, String?)
These APIs were deprecated with a planned removal date of 2026-07-26. Remove any remaining references to them from your code. To replace
NdsStoreConfiguration.copy(File, File?, NdsStoreAccessPermit?, String?), construct a newcom.tomtom.sdk.datamanagement.nds.NdsStoreConfigurationinstance directly.
Location
Updates
com.tomtom.sdk.location.Place.personalLocationTypesis now available in General Availability. You no longer need to opt in toBetaPlacePersonalLocationTypesApito read the personal location types associated with a place.
Map Visualization
Breaking changes
-
Remove the primary constructors of
com.tomtom.sdk.map.display.visualization.navigation.betterroute.BetterRouteStyleandcom.tomtom.sdk.map.display.visualization.navigation.betterroute.BetterRouteMarkerStyle, and replace them with versions that take the degraded style as a final parameter:- removed:
BetterRouteStyle(List<WidthByZoom>, List<WidthByZoom>, Int, BetterRouteMarkerStyle, Boolean) - replaced by:
BetterRouteStyle(List<WidthByZoom>, List<WidthByZoom>, Int, BetterRouteMarkerStyle, Boolean, Int) - removed:
BetterRouteMarkerStyle(Image, Int, Double, Uri, TextAnchoring, PointF) - replaced by:
BetterRouteMarkerStyle(Image, Int, Double, Uri, TextAnchoring, PointF, Image)
Kotlin callers are unaffected, because every parameter has a default value and the order is unchanged, so existing calls still compile. Java callers that invoke the removed constructors must pass the extra argument:
BetterRouteStyle.DEFAULT_DEGRADED_LINE_COLORforBetterRouteStyle.ImageFactory.fromResource(BetterRouteMarkerStyle.DEFAULT_DEGRADED_PIN_IMAGE)forBetterRouteMarkerStyle, because the constant is a drawable resource identifier and the parameter takes anImage.
- removed:
Updates
-
The Compose
HazardVisualizationState,HorizonVisualizationState.hazardVisualizationState, and thehazardVisualizationStateparameter ofrememberHorizonVisualizationStateare now available in General Availability. -
com.tomtom.sdk.map.display.visualization.navigation.horizon.common.HorizonVisualizationandcom.tomtom.sdk.map.display.visualization.navigation.NavigationVisualization.horizonare now available in General Availability. -
The Compose
com.tomtom.sdk.map.display.visualization.navigation.compose.state.HorizonVisualizationState.safetyLocationVisualizationStateis now available in General Availability. -
The following APIs are now available in General Availability:
- property
com.tomtom.sdk.map.display.visualization.navigation.betterroute.BetterRouteStyle.degradedLineColor - property
com.tomtom.sdk.map.display.visualization.navigation.betterroute.BetterRouteStyle.Companion.DEFAULT_DEGRADED_LINE_COLOR - property
com.tomtom.sdk.map.display.visualization.navigation.betterroute.BetterRouteMarkerStyle.degradedPinImage - property
com.tomtom.sdk.map.display.visualization.navigation.betterroute.BetterRouteMarkerStyle.Companion.DEFAULT_DEGRADED_PIN_IMAGE
They style a better route proposal that is no longer better than the active route and is shown as an alternative. Set them through the
BetterRouteStyleandBetterRouteMarkerStyleconstructors, which each take one more optional parameter than before.DEFAULT_DEGRADED_PIN_IMAGEwas namedDEGRADED_PIN_IMAGEwhile it was in Beta, and was renamed to match the other default constants before reaching General Availability. - property
Fixes
- The app no longer crashes on some Samsung devices when a premium map view is hidden or the app goes to the background.
com.tomtom.sdk.map.display.maptilestore.MapTileStorecreated with offline data from an NDS store now releases its offline tile provider when it is closed. Previously the provider stayed registered on the NDS store.- Fix a data race in the map tile request handler that could crash the application when rendering map tiles.
- The app no longer crashes with a
DaichiFatalExceptionwhen map tiles load while the map style is unavailable, for example shortly after the style is unloaded. com.tomtom.sdk.map.display.camera.CameraSteadyListenerno longer stops receivingonCameraSteadyevents after a few seconds of repeated panning and zooming.- Fix a freeze that could occur when the device screen turned off while an offline map update was in progress.
- Stop drawing better route proposals when better route visualization is disabled.
- Fix a visible flash when switching between driving and browsing while lane-level navigation is supported. The map no longer reloads all its tiles during this switch, so the transition is smooth.
- Fix horizon elements, such as safety locations and hazards, remaining visible and updating on top of a route preview shown during free driving, before turn-by-turn guidance starts.
- The map no longer pans unexpectedly at the end of a pinch gesture when panning with two or more fingers is disabled via
com.tomtom.sdk.map.display.gesture.GesturesController.isMultiPointerPanEnabled. - The SDK no longer crashes when its connection to the map display engine is unexpectedly interrupted (for example, if the engine process restarts).
- The Premium Map Display SDK no longer crashes when the map style cannot be written to internal storage (for example on Android Automotive secondary user profiles with read-only storage). The SDK now reports a style loading failure instead.
- Fix lane level safety location markers appearing on the wrong side of the road or at the wrong position when navigating.
- Setting
com.tomtom.sdk.map.display.camera.CameraTrackingMode.Nonenow stops a camera transition that the previous tracking mode had started. Previously that transition kept running and moved the camera to its end position, overriding a camera animation requested straight after. SettingCameraTrackingMode.Nonenow also stops a camera animation that your application started and that is still running. - The map no longer shows outdated routes, polylines, markers, polygons, or polygon overlays after a display adapter is removed and added back to the map, if their content changed while the adapter was removed.
- Fix a map view showing a blank white screen instead of the map in applications that show several map views in one process. Map readiness for these views is now reported once their style has loaded, so it can arrive later than before.
- Fix frame drops and stuttering when the map style changes, for example when switching between driving and browsing. Style changes no longer take progressively longer the more often the style is switched during a map session.
- Send the geopolitical view on online map display tile requests in the format the Orbis Map Display API documents. Configuring a Gulf Cooperation Council country or Iraq now selects the Arabic geopolitical view.
- Fix visual ghosting on devices with Mali GPUs, missing background tiles, and slow 2D-to-3D camera transitions in the Premium Map Display, and make it shut down synchronously.
- Fix the app crashing when a lane-level average speed zone is reported in more than one part.
- The app no longer stops responding (ANR) when a premium map view is hidden or the screen turns off while the map is rendering.
- Fix map icons, such as search result markers, briefly flashing when the map style changes. Icons drawn with the previous sprite sheet now stay visible until the new sprite sheet has fully loaded.
- Fix parts of the Premium Map Display staying empty, with map tiles no longer loading while the camera is at rest, when tile fetches are delayed or the data provider reports a failure.
- The map now zooms out to show the whole route when you plan a route while driving. Previously it stayed at its current zoom.
- The custom chevron no longer turns black on some screens when several map displays are active.
- Stop showing map elements such as safety cameras, school zones and traffic lights on roads off the active route after the vehicle leaves the route. Previously, they appeared with the active route style until the new route was ready, for example as thick zone lines.
- The app is no longer killed with an ANR (“Input dispatching timed out”) while Android has frozen it in the background. This happened mostly on Samsung devices running Android 16 or later.
- Removing a listener from a map that is already closed, for example with
com.tomtom.sdk.map.display.TomTomMap.removeOnMapFpsUpdatedListener, no longer throwsIllegalStateException: Instance has been closed.The call is now ignored. Previously, disposing a Compose map could crash the app with this error during teardown. - When the map camera moves to a distant location, such as a destination preview, it now jumps straight to the final view. The map no longer shows white tiles while the new area loads.
- The app no longer crashes with a
DaichiFatalExceptionwhen a map tile is released while its data is still loading, for example during fast zooming or panning.
Deprecations
-
Deprecate
com.tomtom.sdk.map.display.trafficdataprovider.TrafficDataProviderFactory.createTrafficDataProvider(com.tomtom.sdk.traffic.Traffic)andcom.tomtom.sdk.map.display.trafficdataprovider.TrafficDataProviderFactory.createTrafficDataProvider(com.tomtom.sdk.traffic.Traffic, Int). These overloads have no public replacement: theTrafficclient is becoming internal, so a traffic data provider is no longer created from it directly. -
Deprecate
com.tomtom.sdk.map.display.visualization.navigation.NavigationVisualization.safetyLocationVisualization.Use the safetyLocation property on
com.tomtom.sdk.map.display.visualization.navigation.NavigationVisualization.horizoninstead. Replace navigationVisualization.safetyLocationVisualization with navigationVisualization.horizon.safetyLocation wherever it is used.
Removals
-
Remove
com.tomtom.sdk.map.display.visualization.poi.PoiVisualizationFactoryandcom.tomtom.sdk.map.display.visualization.poi.PoiVisualizationFactory.create(TomTomMap)from the public API.These were deprecated in an earlier release and are no longer available for external use.
-
Remove
com.tomtom.sdk.map.display.visualization.range.RangeVisualizationFactory.create(TomTomMap, RangeVisualizationStyle). This API was deprecated in an earlier release and had no public replacement. -
Remove deprecated
com.tomtom.sdk.map.display.MapOptions(String, CameraOptions?, Padding, StyleDescriptor?, StyleMode, OnlineCachePolicy, Boolean)constructor. -
Remove deprecated
com.tomtom.sdk.map.display.MapOptions.cameraOptionsproperty. -
Remove deprecated
com.tomtom.sdk.map.display.visualization.navigation.GuidanceTypeclass. -
Remove deprecated
com.tomtom.sdk.map.display.visualization.navigation.NavigationVisualization.guidanceTypeproperty. -
Remove deprecated
com.tomtom.sdk.map.display.visualization.search.SearchResult.toPoiLocation()extension function.
Navigation
Breaking changes
- The SDK no longer provides
PoiElementorPoiElementType. UsePoiElement2andPoiElementType2instead.
Updates
-
Restore
com.tomtom.sdk.navigation.offline.Configuration(Context, NdsStore, LocationProvider, RoutePlanner, VehicleProvider?, BetterProposalAcceptanceMode?, DeviationReplanningMode?)andcom.tomtom.sdk.navigation.offline.Configuration(Context, NdsStore, NdsMapUpdater?, LocationProvider, RoutePlanner?, VehicleProvider?, BetterProposalAcceptanceMode?, DeviationReplanningMode?, ReplanningRetryPolicy?, RouteReplanningEngine?, DataStoreMaintenanceEngine?, GuidanceEngine?, HorizonEngine?, MapMatchingEngine?, RouteTrackingEngine?, RouteProgressEngine?, ArrivalDetectionEngine?, SafetyLocationsConfiguration?, HazardsConfiguration?)to their previous non-deprecated state. No action is required. -
Restore
com.tomtom.sdk.navigation.TomTomNavigation.vehicleProviderto its previous non-deprecated state. No action is required. -
The following APIs are now available in General Availability:
- class
com.tomtom.sdk.navigation.RouteRole - class
com.tomtom.sdk.navigation.RouteRole.Alternative - class
com.tomtom.sdk.navigation.RouteRole.Proposal - class
com.tomtom.sdk.navigation.RouteRole.Proposal.Better - class
com.tomtom.sdk.navigation.RouteRole.Proposal.AvoidBlockage - class
com.tomtom.sdk.navigation.RouteRole.Proposal.WithinRange - constructor
com.tomtom.sdk.navigation.RouteUpdatedReason.Refresh(RouteRole) - property
com.tomtom.sdk.navigation.RouteUpdatedReason.Refresh.transitionedTo - constructor
com.tomtom.sdk.navigation.replanning.RouteReplanningReason.Refresh(RouteRole) - property
com.tomtom.sdk.navigation.replanning.RouteReplanningReason.Refresh.transitionedTo - property
com.tomtom.sdk.navigation.TripSnapshot.alternativeRoutes
A better route proposal that is no longer better than the active route now stays in the navigation session as an alternative route until the driver passes the fork point. Previously it was removed from the session. Read
transitionedToon aRefreshreason to see the new role of the route. - class
Fixes
- Guidance confirmation predictions no longer use the wrong verbal style based on whether the main announcement phase has passed.
com.tomtom.sdk.tts.android.AndroidTextToSpeechEngineno longer triggers an ANR (Application Not Responding) during initialization when the app is in the background.- Give each turn-by-turn guidance instruction a unique identifier, so expanding the instruction list no longer crashes when a route stop is at the same location as the destination.
- The speed limit is no longer reported as unknown while driving through a roundabout that is mapped as a special traffic figure, or for a stretch after leaving it.
com.tomtom.sdk.location.Place.idof route stops is no longernullafter navigation is restored from acom.tomtom.sdk.navigation.navigationresumesnapshot.NavigationResumeSnapshot. Previously the place identifier was not stored in the snapshot, so apps could not re-resolve POI details for the stops on the resumed route.- The navigation location context now holds the last known country, road, and speed limit through a brief gap in map data while you are still on a mapped road, instead of momentarily reporting them as empty. This stops short-lived side effects such as the unit system switching to metric in the United States, or tunnel and country-dependent information dropping out for a few seconds, when crossing a border, driving through a tunnel, or replanning a route.
- Onboard map updates no longer stall, and map data access is no longer repeatedly restricted, after navigation stops or the route changes at the exact moment a location update is being processed. Previously navigation could keep holding a map data lock, so a map update could hang (for example at 70%) and map matching, hazards, and search kept reporting that access to the map was restricted.
- Restore delivery of safety locations and hazards after a temporary loss of network connectivity. Previously, Horizon could stop reporting them after such temporary connectivity loss.
- Continuous replanning triggered by ETA or state-of-charge deviation no longer retries immediately after a failed replanning attempt. This prevents repeated failing replanning requests on the same trip.
- Route replanning no longer fails for electric vehicle routes that include a charging stop. Previously, replanning such a route while driving could stop recognizing the charging stop, so no new route was found for the rest of the trip.
- The SDK no longer automatically dismisses a Better Route proposal a few seconds after suggesting it. This previously happened when the proposal was suggested shortly after departing a waypoint on a multi-stop route, such as a charging stop.
- Navigation no longer switches repeatedly between onboard and online map data while you drive without a route and without a working internet connection. Previously the data source could change back and forth even though no new map data could be downloaded.
- Fix
com.tomtom.sdk.asset.RoadShieldIconProvider.provideExitSignIconto render USA and Canada highway exit shields with white text on a transparent background, matching real-world signage, instead of a solid black-and-yellow design. - The SDK no longer discards a better route proposal because its fork point is far ahead, when
com.tomtom.sdk.navigation.MutableNavigationConfiguration.betterProposalAcceptanceModeisAutomatic. Previously such a proposal was dropped if the fork point was more than 10 minutes away, so a faster route could go unused on long trips, even with a delay of nearly an hour ahead. - The SDK no longer downloads extra map and live-service data during free driving when safety-location or hazard warnings are active. Previously it prefetched this data to a fixed distance ahead, regardless of the horizon distance requested by the client.
- The SDK no longer crashes when an electric vehicle arrives at a charging stop and the route is updated there. Previously the already-traversed route leg had 0 predicted energy consumption, which caused a crash.
- On a route, the SDK no longer prefetches map data beyond the destination. Previously it kept prefetching a fixed distance ahead as the vehicle neared arrival.
- Fix a rounding issue in the route data window calculation that caused
VehicleHorizonto treat a fully covered route as incomplete, resulting in missing horizon data. - Fix the pronunciation of Dutch road numbers in spoken guidance. This applies to announcements played through
com.tomtom.sdk.tts.android.AndroidTextToSpeechEngine. - Fix the vehicle position being shown leaving a roundabout at an earlier exit while the vehicle is still driving on the roundabout.
- Fix a crash during navigation in areas where the map data contains zero-length lane groups that are not preceded by a regular road lane group.
- Fix a rare ANR (Application Not Responding) that could occur when navigation stops while horizon updates are still being processed.
- Fix the guidance panel showing “Calculating route…” instead of the current street name after a reroute that occurred while the app was in the background.
- Stop the app crashing during guidance on routes that contain two consecutive points at the same location. Previously, the reported distance along the route could become a large negative value on such routes, and drawing the route then crashed the app.
- Fix subscription timeouts for safety locations and hazard warnings on slow network connections. Previously, the SDK could fail to subscribe when a slow connection took more than 10 seconds to respond.
Removals
-
Remove the off-road navigation API, including
com.tomtom.sdk.navigation.offroad.OffRoadTomTomNavigationFactoryandcom.tomtom.sdk.navigation.offroad.Configuration. This feature was deprecated in NavSDK 2.0 and had no replacement. If you need off-road handling, build it in your own application. -
Remove
com.tomtom.sdk.navigation.RouteUpdatedListener,com.tomtom.sdk.navigation.TomTomNavigation.addRouteUpdatedListener(RouteUpdatedListener), andcom.tomtom.sdk.navigation.TomTomNavigation.removeRouteUpdatedListener(RouteUpdatedListener), deprecated in an earlier release. Usecom.tomtom.sdk.navigation.RouteUpdatedListener2withcom.tomtom.sdk.navigation.TomTomNavigation.addRouteUpdatedListener2(RouteUpdatedListener2)andcom.tomtom.sdk.navigation.TomTomNavigation.removeRouteUpdatedListener2(RouteUpdatedListener2)instead. -
Remove
com.tomtom.sdk.navigation.TomTomNavigation.betterProposalAcceptanceModeandcom.tomtom.sdk.navigation.TomTomNavigation.unitSystem, deprecated in an earlier release. Read and change these settings throughcom.tomtom.sdk.navigation.TomTomNavigation.configurationinstead, usingcom.tomtom.sdk.navigation.MutableNavigationConfiguration.betterProposalAcceptanceMode,com.tomtom.sdk.navigation.MutableNavigationConfiguration.unitSystemandcom.tomtom.sdk.navigation.MutableNavigationConfiguration.update(Function1). -
Remove
com.tomtom.sdk.navigation.replanning.ReplanningRetryPolicy.calculateRetryDelay(Int)from the public API, deprecated in an earlier release.com.tomtom.sdk.navigation.replanning.ReplanningRetryPolicyitself is unchanged. Obtain a retry policy fromcom.tomtom.sdk.navigation.replanning.ReplanningRetryPolicyFactory.create(Duration)instead of implementing the interface yourself. -
Remove deprecated
com.tomtom.sdk.navigation.guidance.instruction.BorderCrossing.copy()method. -
Remove deprecated
com.tomtom.sdk.navigation.guidance.instruction.BorderCrossingdestructuring declarations. -
Remove deprecated
com.tomtom.sdk.navigation.guidance.instruction.Country.copy()method. -
Remove deprecated
com.tomtom.sdk.navigation.guidance.instruction.Countrydestructuring declarations. -
Remove deprecated
com.tomtom.sdk.navigation.guidance.instruction.Road.copy()method. -
Remove deprecated
com.tomtom.sdk.navigation.guidance.instruction.Roaddestructuring declarations. -
Remove the previously deprecated
NavigationSnapshotoverloads fromGuidanceEngineandMapMatchingEngine.Removed APIs:
com.tomtom.sdk.navigation.guidance.GuidanceEngine.generateGuidance(NavigationSnapshot):Guidancecom.tomtom.sdk.navigation.guidance.GuidanceEngine.generateLaneGuidance(NavigationSnapshot):LaneGuidanceUpdate?com.tomtom.sdk.navigation.mapmatching.MapMatchingEngine.matchLocation(NavigationSnapshot):MapMatchingResultcom.tomtom.sdk.navigation.mapmatching.MapMatchingEngine.extrapolateLocation(NavigationSnapshot):MapMatchingResult?
Personalization
Fixes
- The app no longer crashes when a request to the personal data backend times out while the response is being received during personal data synchronization. Synchronization now retries the request instead.
- Fix an application freeze when personal data is created.
com.tomtom.sdk.personaldata.PersonalDataFactory.create(Context, File, OnlinePersonalDataConfiguration)blocked the calling thread for several seconds on its first call, which could freeze an application that creates personal data while starting up. - The online personal data client no longer sends requests to the personalization service when the token provider returns a blank token. Such requests failed with 401 and were retried indefinitely.
- The SDK no longer crashes on start after an upgrade when personal data sync tasks are still stored on the device. Previously, a stored sync task could be read as a different task, which ended the process on every start until the user cleared app data.
- Fix a crash that occurred when a place was saved as a personal location if its routing entry point specified a purpose, such as parking or pedestrian access.
- Fix a crash that occurred when a personal location was loaded whose place has an entry point of a type the SDK does not recognize. Such entry points are now skipped.
- The personal data component no longer writes saved addresses, exact coordinates or the device identifier to its warning and error logs, and the message of
UserProfileFailure.DeserializationFailureno longer contains the saved place. A failed request to the personal data backend now also releases its network connection.
Routing
Updates
- The route planning options builders are now available in General Availability:
com.tomtom.sdk.routing.options.RoutePlanningOptions.Builder,com.tomtom.sdk.routing.options.RoutePlanningOptions.EvBuilder,com.tomtom.sdk.routing.options.buildRoutePlanningOptions(Itinerary, RoutePlanningOptions.Builder.()->Unit), andcom.tomtom.sdk.routing.options.buildEvRoutePlanningOptions(Itinerary, ChargingOptions, RoutePlanningOptions.EvBuilder.()->Unit). - Orbis online routing now uses the TomTom Orbis Routing v3 API by default.
Fixes
- Fix opening hours of charging parks on EV routes being reported in the device’s time zone instead of the charging park’s local time zone.
- Replanned routes no longer ignore the avoidance criteria set in
com.tomtom.sdk.routing.options.RoutePlanningOptions.avoidOptionswhen the options were created without a route type. - Fix incorrect, and sometimes negative, electric-vehicle energy values returned by
com.tomtom.sdk.routing.route.Route.consumptionInLegUpTo(Distance, AuxiliaryPower?)for the leg after a charging stop. This occurred when a route was refreshed while driving and the vehicle had charged more than originally planned. - Prevent a crash when planning an offline route with a non-motorized vehicle, such as a pedestrian or bicycle.
- Fix a rare native crash that could occur when offline route planning was cancelled.
- Online EV route planning no longer duplicates a route stop and drops a neighboring waypoint when two waypoints are close to each other.
- Fix a crash when navigation starts on a route that was planned with a
com.tomtom.sdk.routing.options.RouteLegOptionswithout supporting points, for example when the first leg drives up to the start of an imported track. - Fix a waypoint at a place with entry points being reported as an auto-generated stop on EV routes. Previously, if the routing service selected an entry point far from the place coordinate, the waypoint lost its name, ID, and source type, causing apps that filter route stops by source type to skip the stop and a subsequent replan to drop the waypoint from the route.
- Stop the app from crashing when a map update starts right after an offline route calculation with alternatives is cancelled.
Deprecations
- Deprecate
com.tomtom.sdk.routing.buildRoutePlanningOptions(Itinerary, Int, RouteType, Set<AvoidType>, Locale, InstructionPhoneticsType)andcom.tomtom.sdk.routing.buildEvRoutePlanningOptions(Itinerary, ChargingOptions, Int, Set<AvoidType>, Locale, InstructionPhoneticsType). Usecom.tomtom.sdk.routing.options.buildRoutePlanningOptions(Itinerary, RoutePlanningOptions.Builder.()->Unit)andcom.tomtom.sdk.routing.options.buildEvRoutePlanningOptions(Itinerary, ChargingOptions, RoutePlanningOptions.EvBuilder.()->Unit)instead. To migrate, change the import to thecom.tomtom.sdk.routing.optionspackage and move each explicit parameter (maxAlternatives, routeType, avoids, language, instructionPhoneticsType) into the trailing lambda.
Removals
- Remove the deprecated
com.tomtom.sdk.routing.route.Summaryconstructors and thecom.tomtom.sdk.routing.route.Summary.departureTimeWithZoneandcom.tomtom.sdk.routing.route.Summary.arrivalTimeWithZoneproperties, deprecated in an earlier release. Readcom.tomtom.sdk.routing.route.Summary.departureTimeandcom.tomtom.sdk.routing.route.Summary.arrivalTime, which give the same times asjava.time.ZonedDateTime.Summaryis returned by the SDK and can no longer be built by your application. These two properties now report the time zone the route was planned with, so a route planned with aZoffset reportsZwhere it previously reportedUTC. Both describe the same moment in time. - Remove deprecated
com.tomtom.sdk.routing.options.Itinerary.copy()method. - Remove deprecated
com.tomtom.sdk.routing.options.Itinerarydestructuring declarations. - Remove deprecated
com.tomtom.sdk.routing.options.calculation.AlternativeRoutesOptions.copy()method. - Remove deprecated
com.tomtom.sdk.routing.options.calculation.AlternativeRoutesOptionsdestructuring declarations. - Remove deprecated
com.tomtom.sdk.routing.options.calculation.AvoidOptions.copy()method. - Remove deprecated
com.tomtom.sdk.routing.options.calculation.AvoidOptionsdestructuring declarations. - Remove deprecated
com.tomtom.sdk.routing.range.Range.copy()method. - Remove deprecated
com.tomtom.sdk.routing.range.Rangedestructuring declarations. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.Road.copy()method. - Remove deprecated
com.tomtom.sdk.routing.route.instruction.Roaddestructuring declarations.
Search
Fixes
- Fix EV along-route search ignoring the nearby POI category filter, for example restaurant or hotel. Previously, charging stations without the selected amenity were returned.
- Fix a place’s opening hours incorrectly showing as closed all day when it closes exactly at midnight.
- Fix a crash that could happen when requesting EV charge point operators or e-mobility service providers from offline search while the offline map was being closed, switched, or updated.
- Offline search no longer terminates the application when it cannot read the map data needed for a request, for example when a map file is missing from the installed map. It now reports a failure through the search callback instead.
- Fix online EV search ranking preferred charge point operators and e-mobility service providers incorrectly after a brand was renamed, so results sometimes did not match your preference.
- Fix offline search not finding South Korean land-lot (jibun, 지번) addresses on Orbis Korea maps.
- The SDK no longer delays offline autocomplete search results when a query is typed quickly, letter by letter. Previously, cancelling an outdated request did not stop it, so it kept running and could delay the response to the latest keystroke by several seconds.
- Fix
evSearchandrequestEvPoiDetailsso EV charging tariffs are no longer returned when the required telemetry consent has not been given, consistent with how charging point availability is already handled. - The app no longer crashes when an offline map has a country without eMobility service providers and the app requests the list of providers. The request now returns the providers of the other countries.
- Fix poor offline search ranking for Japanese queries that contain a category name, such as 高校 (high school). Previously, Kana voicing marks in such queries were ignored, so a search for せいじょう also matched せいしょう.
Telemetry
Fixes
- Fix telemetry upload not resuming when consent is turned off and back on in the same session. Previously, no telemetry was uploaded until the app restarted. Telemetry that was queued before consent was turned off, or collected while it was off, is now discarded and never uploaded.
Traffic
Deprecations
-
Deprecate the traffic-client creation APIs
com.tomtom.sdk.traffic.client.TrafficClientFactory.create(Context, String, NdsStore, LocationProvider, Locale),com.tomtom.sdk.traffic.client.TrafficClientFactory.createOfflineMode(Context, String, NdsStore, LocationProvider, Locale),com.tomtom.sdk.traffic.client.TrafficClientFactory.createOnlineMode(Context, String, NavigationTileStore, LocationProvider, Locale), andcom.tomtom.sdk.traffic.client.TrafficClientFactory.createWithTpegProvider(Context, TrafficTpegConfiguration, NdsStore, LocationProvider, Locale), together with thecom.tomtom.sdk.traffic.client.TrafficTpegConfigurationclass, its constructor, its properties, and itsCompanionconstants.These APIs have no public replacement. The traffic client is being made internal, so it can no longer be constructed directly; traffic is handled through the map data store rather than a traffic client you create yourself. To adapt your project, remove any direct calls to the
com.tomtom.sdk.traffic.client.TrafficClientFactorycreation methods and any use ofcom.tomtom.sdk.traffic.client.TrafficTpegConfiguration, and obtain traffic through your map data store instead. -
Deprecate the client-side traffic data interface and its associated types:
com.tomtom.sdk.traffic.Traffic,com.tomtom.sdk.traffic.TrafficEvent,com.tomtom.sdk.traffic.TrafficEventsResult,com.tomtom.sdk.traffic.TrafficEventsCallback,com.tomtom.sdk.traffic.TrafficChangedListener, andcom.tomtom.sdk.traffic.TrafficError(includingcom.tomtom.sdk.traffic.TrafficError.DeserializationError).These types have no public replacement. The traffic client is being made internal, so it can no longer be constructed or consumed directly; traffic is delivered through the map data store instead. To adapt your project, remove any direct use of these types and obtain traffic through your map data store.
-
Deprecate the client-side traffic domain types
com.tomtom.sdk.traffic.Category,com.tomtom.sdk.traffic.Cause,com.tomtom.sdk.traffic.CauseCode,com.tomtom.sdk.traffic.EffectCode,com.tomtom.sdk.traffic.RoadClass,com.tomtom.sdk.traffic.RoadSubClass,com.tomtom.sdk.traffic.RoadType, andcom.tomtom.sdk.traffic.WarningLevel.These types have no public replacement; remove any direct use of them. Traffic is delivered through the map data store instead of being consumed via these client-side types.
Vehicle
Fixes
- Fix
com.tomtom.sdk.vehicle.Vehicle.Caraccepting amaxSpeedoutside its valid range (0 to 250 km/h); the invalid value was passed on to route planning. The constructor now throwsIllegalArgumentExceptionfor an out-of-rangemaxSpeed, andcom.tomtom.sdk.vehicle.VehicleProvider.updateVehiclerejects it and reportscom.tomtom.sdk.vehicle.property.PropertyId.MaxSpeedinrejectedProperties. Make sure themaxSpeedyou set is within this range.
Removals
- Remove
com.tomtom.sdk.vehicle.ChargeLevel.component1(),com.tomtom.sdk.vehicle.ChargeLevel.component2()andcom.tomtom.sdk.vehicle.ChargeLevel.copy(Energy,Energy), deprecated in an earlier release. Readcom.tomtom.sdk.vehicle.ChargeLevel.currentChargeandcom.tomtom.sdk.vehicle.ChargeLevel.maxChargedirectly, and build a new instance with the constructor.
Virtual Horizon
Fixes
- The horizon no longer extends beyond the route destination when the vehicle stands off the road network during active guidance. Previously, the SDK could report horizon elements far past the destination.
Removals
-
Remove the deprecated public constructors of
com.tomtom.sdk.navigation.horizon.HorizonSnapshotStateand the deprecatedcom.tomtom.sdk.navigation.horizon.HorizonSnapshotState.updateCounterproperty.Removed APIs (previously deprecated):
com.tomtom.sdk.navigation.horizon.HorizonSnapshotState(Int)com.tomtom.sdk.navigation.horizon.HorizonSnapshotState(Int,Int)com.tomtom.sdk.navigation.horizon.HorizonSnapshotState.updateCounter:Int
com.tomtom.sdk.navigation.horizon.HorizonSnapshotState.resetCounterremains public and read-only. -
Remove the previously deprecated
com.tomtom.sdk.navigation.horizon.RouteLengthPolicy. Usecom.tomtom.sdk.navigation.horizon.ExplicitDistancePolicywith acom.tomtom.sdk.navigation.horizon.PathSearchDistanceto bind the horizon to an explicit search distance. -
Remove the deprecated
com.tomtom.sdk.safetylocations.model.SafetyLocationType.Companion.getAllSafetyLocationTypes(). To obtain the list of safety location types, reference the individualSafetyLocationTypeconstants directly. -
Remove the roadworks hazard type. The following APIs are no longer available:
com.tomtom.sdk.hazards.model.HazardType.Companion.Roadworks:com.tomtom.sdk.hazards.model.HazardType.Companion.getAllHazardTypes():List<HazardType>com.tomtom.sdk.hazards.model.DetailedHazardInformation.RoadWorksand all its members
The SDK no longer reports roadworks hazards. Remove any usage of these APIs from your code.
-
Remove the boolean-based constructors and associated boolean properties from hazard detail classes:
com.tomtom.sdk.hazards.model.DetailedHazardInformation.BadRoadConditions(Boolean)andcom.tomtom.sdk.hazards.model.DetailedHazardInformation.BadRoadConditions.hasPotholes:Booleancom.tomtom.sdk.hazards.model.DetailedHazardInformation.ObjectsOnRoad(Boolean?,Boolean?),com.tomtom.sdk.hazards.model.DetailedHazardInformation.ObjectsOnRoad.animal:Boolean?, andcom.tomtom.sdk.hazards.model.DetailedHazardInformation.ObjectsOnRoad.people:Boolean?com.tomtom.sdk.hazards.model.DetailedHazardInformation.ReducedVisibility(Boolean?,Boolean?),com.tomtom.sdk.hazards.model.DetailedHazardInformation.ReducedVisibility.dueToFog:Boolean?, andcom.tomtom.sdk.hazards.model.DetailedHazardInformation.ReducedVisibility.dueToHeavyRain:Boolean?
Use the
Set<Cause>-based constructors instead. -
Remove
com.tomtom.sdk.navigation.horizon.elements.traffic.TrafficEventElementandcom.tomtom.sdk.navigation.horizon.elements.traffic.TrafficEventElementType. Usecom.tomtom.sdk.navigation.horizon.elements.traffic.TrafficElementandcom.tomtom.sdk.navigation.horizon.elements.traffic.TrafficElementTypeinstead. -
Remove the previously deprecated
NavigationSnapshotoverload fromHorizonEngine.Removed API:
com.tomtom.sdk.navigation.horizon.HorizonEngine.generateHorizon(List<HorizonOptions>,NavigationSnapshot):List<HorizonResult>