Version 0.36.0 - 14/12/2023

Check the API Reference

General

Breaking changes

• RegionGraphChangeEvents can now no longer be constructed by the client.
• Replaced TomTomSDKCommon.Van.init(maxSpeed:isCommercial:combustionEngine:electricEngine:dimensions:modelID:) initializer with TomTomSDKCommon.Van.init(maxSpeed:isCommercial:combustionEngine:electricEngine:dimensions:loadType:generalLoadType:dangerousGoodsLoadType:adrTunnelRestrictionCode:modelID:).
• The errorCode parameter of CompletedMapOperation is renamed to error.

New Features

• Make TomTomSDKCommon.Van conforming to TomTomSDKCommon.CargoCapable protocol.

Known issues

An incorrect routing endpoint is set by default in Guidance v2, making route calculations impossible with version 0.36.0 for some customers. Potential problems include prompts for a valid API key, such as:

“Your API key is invalid.” “Your API key does not support either the Routing API or the Routing API with Extended Guidance endpoints.”.

Resolution of the issue involves upgrading SDK to version 0.39.1 or later.

Map

Breaking changes

• Add FollowRouteNorthUp camera tracking mode.

New Features

• Add support for single geoJSON polygon.
• Implement better route proposals in NV module.
• Introduce GeoJSON support for polygon overlay.

Fixes

• Disable range visualization on the route by default.

Navigation

Breaking changes

• BetterProposalAcceptanceMode.default value was removed. Use BetterProposalAcceptanceMode.automatic instead.
• Properties of TomTomSDKNavigation.NavigationSnapshotError.unavailableRoutePlan has been replaced with TomTomSDKNavigation.NavigationSnapshotError.unavailableTripSnapshot.
• Removed TomTomSDKNavigation.DeviationReplanningMode.default case. Use TomTomSDKNavigation.DeviationReplanningMode.automatic instead.
• Removed TomTomSDKNavigationEngines.HorizonElementType.regionType.
• Removed TomTomSDKNavigationEngines.RegionElement. Use TomTomSDKNavigationEngines.CountryInformationElement.countryName instead of TomTomSDKNavigationEngines.RegionElement.country. Use TomTomSDKNavigationEngines.CountryInformationElement.regionName instead of TomTomSDKNavigationEngines.RegionElement.subCountry.
• Removed TomTomSDKNavigationEngines.RoutePlanChangeReason.
• Renamed TomTomSDKNavigation.NavigationRouteTrackingStateUpdateObserver.onRouteTrackingStateUpdate to TomTomSDKNavigation.NavigationRouteTrackingStateUpdateObserver.didUpdateRouteTrackingState.
• Renamed TomTomSDKNavigationEngines.CountryInformationElement.countryCode to TomTomSDKNavigationEngines.CountryInformationElement.countryCodeISO3.
• The following properties of TomTomSDKNavigation.NavigationSnapshot has been replaced or removed: NavigationSnapshot.location has been replaced with NavigationSnapshot.locationSnapshot.rawLocation. NavigationSnapshot.lastMapMatchingResult has been replaced with NavigationSnapshot.locationSnapshot.mapMatchingResult. NavigationSnapshot.locationContext has been replaced with NavigationSnapshot.locationSnapshot.locationContext. NavigationSnapshot.activeRouteData has been replaced with NavigationSnapshot.tripSnapshot.activeRoute and NavigationSnapshot.tripSnapshot.betterProposal. NavigationSnapshot.alternativeRoutePlans has been removed from NavigationSnapshot API level. NavigationSnapshot.currentRouteProgress has been replaced with NavigationSnapshot.tripSnapshot.activeRoute.routeProgress. NavigationSnapshot.currentWaypointsState has been replaced with NavigationSnapshot.tripSnapshot.activeRoute.nextWaypoint, NavigationSnapshot.tripSnapshot.activeRoute.numberOfVisitedWaypoints and NavigationSnapshot.tripSnapshot.activeRoute.waypointArrivalHistory. NavigationSnapshot.unitSystem has been replaced with NavigationSnapshot.configurationSnapshot.unitSystem. NavigationSnapshot.locale has been replaced with NavigationSnapshot.configurationSnapshot.language. NavigationSnapshot.hasArrived has been replaced with NavigationSnapshot.tripSnapshot.hasReachedDestination. NavigationSnapshot.projectedRoutes has been replaced with NavigationSnapshot.tripSnapshot.activeRoute.projection and NavigationSnapshot.tripSnapshot.betterProposal.projection. NavigationSnapshot.activeRoute has been removed from NavigationSnapshot API level.

New Features

• Introduced new ConfigurationSnapshot API in Public Preview.
• Introduced new DrivingHistorySnapshot API in Public Preview.
• Introduced new LocationSnapshot API in Public Preview.
• Introduced new RouteSnapshot API in Public Preview.
• Introduced new TripSnapshot API in Public Preview.

Fixes

• Fix out-of-memory crash during navigation with long route.

Updates

• NavigationTileStore.AreaAlongRoute is now available in General Availability.
• NavigationTileStore.CacheStorageConfiguration is now available in General Availability.
• TomTomSDKNavigation.DeviationReplanningMode is now available in General Availability.
• TomTomSDKNavigation.GuidanceUpdateObserver is now available in General Availability.
• TomTomSDKNavigation.TomTomNavigation.deviationReplanningMode is now available in General Availability.
• TomTomSDKNavigationEngines.BetterProposalAcceptanceMode promoted to GA.
• Added collaboration tests for HorizonObservers.
• Replaced current NavigationSnapshot properties with locationSnapshot, historySnapshot, configurationSnapshot, vehicleSnapshot, tripSnapshot properties.
• The methods TomTomSDKNavigation.TomTomNavigation/addGuidanceUpdateObserver and TomTomSDKNavigation.TomTomNavigation/removeGuidanceUpdateObserver is now available in General Availability.
• The methods TomTomSDKNavigation.TomTomNavigation/addLaneGuidanceUpdateObserver and TomTomSDKNavigation.TomTomNavigation/removeLaneGuidanceUpdateObserver is now available in General Availability.
• Update the documentation for the methods in TomTomSDKNavigation.TomTomNavigation.

Routing

Breaking changes

• TomTomSDKRoutePlanner.RoutingOptionsError is moved to TomTomSDKRoutingCommon.RoutingOptionsError. Replace usages of TomTomSDKRoutePlanner.RoutingOptionsError with TomTomSDKRoutingCommon.RoutingOptionsError.

Deprecations

• Deprecated TomTomRoutePlanner.AnnouncementPoints.

Fixes

• Changed the condition for the storing the last announcement instruction.
• Not settin allow or avoid vignettes on Orbis.

Updates

• TomTomSDKRoutePlanner.RoutePlanner.planRoute is now available in General Availability.

Search

Updates

• Introduced a factory for OfflineSearch.
• Updated search URL configuration used under TomTom Orbis Map feature toggle.

Traffic

Breaking changes

• Removed functions and variables that should not be in the public interface: TomTomSDKTrafficTPEG.TPEGTrafficService.notifyMapLoaded(), TomTomSDKTrafficTPEG.TPEGTrafficService.notifyMapUnloading(), TomTomSDKTrafficTPEG.TPEGTrafficService.onAuthorizationStatusChanged(isGranted:) TomTomSDKTrafficTPEG.TPEGTrafficService.onHeadingUpdate(newHeading:lastLocation:), TomTomSDKTrafficTPEG.TPEGTrafficService.onLocationUpdated(location:), TomTomSDKTrafficTPEG.TPEGTrafficService.onReadOnlyAccessGranted(mapChanged:), TomTomSDKTrafficTPEG.TPEGTrafficService.onReadOnlyAccessReleaseRequested(accessReleased:), TomTomSDKTrafficTPEG.TPEGTrafficService.onStoreAccessChangedObserverId.

Updates

• Introduced a provider agnostic traffic engine: TomTomSDKTrafficEngine.