Release Notes
Version 0.36.0 - 14/12/2023
General
Breaking changes
RegionGraphChangeEvents
can now no longer be constructed by the client.- Replaced
TomTomSDKCommon.Van.init(maxSpeed:isCommercial:combustionEngine:electricEngine:dimensions:modelID:)
initializer withTomTomSDKCommon.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 toTomTomSDKCommon.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. UseBetterProposalAcceptanceMode.automatic
instead.- Properties of
TomTomSDKNavigation.NavigationSnapshotError.unavailableRoutePlan
has been replaced withTomTomSDKNavigation.NavigationSnapshotError.unavailableTripSnapshot
. - Removed
TomTomSDKNavigation.DeviationReplanningMode.default
case. UseTomTomSDKNavigation.DeviationReplanningMode.automatic
instead. - Removed
TomTomSDKNavigationEngines.HorizonElementType.regionType
. - Removed
TomTomSDKNavigationEngines.RegionElement
. UseTomTomSDKNavigationEngines.CountryInformationElement.countryName
instead ofTomTomSDKNavigationEngines.RegionElement.country
. UseTomTomSDKNavigationEngines.CountryInformationElement.regionName
instead ofTomTomSDKNavigationEngines.RegionElement.subCountry
. - Removed
TomTomSDKNavigationEngines.RoutePlanChangeReason
. - Renamed
TomTomSDKNavigation.NavigationRouteTrackingStateUpdateObserver.onRouteTrackingStateUpdate
toTomTomSDKNavigation.NavigationRouteTrackingStateUpdateObserver.didUpdateRouteTrackingState
. - Renamed
TomTomSDKNavigationEngines.CountryInformationElement.countryCode
toTomTomSDKNavigationEngines.CountryInformationElement.countryCodeISO3
. - The following properties of
TomTomSDKNavigation.NavigationSnapshot
has been replaced or removed:NavigationSnapshot.location
has been replaced withNavigationSnapshot.locationSnapshot.rawLocation
.NavigationSnapshot.lastMapMatchingResult
has been replaced withNavigationSnapshot.locationSnapshot.mapMatchingResult
.NavigationSnapshot.locationContext
has been replaced withNavigationSnapshot.locationSnapshot.locationContext
.NavigationSnapshot.activeRouteData
has been replaced withNavigationSnapshot.tripSnapshot.activeRoute
andNavigationSnapshot.tripSnapshot.betterProposal
.NavigationSnapshot.alternativeRoutePlans
has been removed fromNavigationSnapshot
API level.NavigationSnapshot.currentRouteProgress
has been replaced withNavigationSnapshot.tripSnapshot.activeRoute.routeProgress
.NavigationSnapshot.currentWaypointsState
has been replaced withNavigationSnapshot.tripSnapshot.activeRoute.nextWaypoint
,NavigationSnapshot.tripSnapshot.activeRoute.numberOfVisitedWaypoints
andNavigationSnapshot.tripSnapshot.activeRoute.waypointArrivalHistory
.NavigationSnapshot.unitSystem
has been replaced withNavigationSnapshot.configurationSnapshot.unitSystem
.NavigationSnapshot.locale
has been replaced withNavigationSnapshot.configurationSnapshot.language
.NavigationSnapshot.hasArrived
has been replaced withNavigationSnapshot.tripSnapshot.hasReachedDestination
.NavigationSnapshot.projectedRoutes
has been replaced withNavigationSnapshot.tripSnapshot.activeRoute.projection
andNavigationSnapshot.tripSnapshot.betterProposal.projection
.NavigationSnapshot.activeRoute
has been removed fromNavigationSnapshot
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
andTomTomSDKNavigation.TomTomNavigation/removeGuidanceUpdateObserver
is now available in General Availability. - The methods
TomTomSDKNavigation.TomTomNavigation/addLaneGuidanceUpdateObserver
andTomTomSDKNavigation.TomTomNavigation/removeLaneGuidanceUpdateObserver
is now available in General Availability. - Update the documentation for the methods in
TomTomSDKNavigation.TomTomNavigation
.
Routing
Breaking changes
TomTomSDKRoutePlanner.RoutingOptionsError
is moved toTomTomSDKRoutingCommon.RoutingOptionsError
. Replace usages ofTomTomSDKRoutePlanner.RoutingOptionsError
withTomTomSDKRoutingCommon.RoutingOptionsError
.
Deprecations
- Deprecated
TomTomRoutePlanner.AnnouncementPoints
.
Fixes
- Changed the condition for the storing the last announcement instruction.
- Not settin
allow
oravoid
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
.