TomTom SDK for iOS (0.42.1)
TomTom SDK for iOS
TomTomArrivalDetectionEngine
TomTomArrivalDetectionEngine
public class TomTomArrivalDetectionEngine : ArrivalDetectionEngineTomTomArrivalDetectionEngine checks if the driver has reached the destination or waypoint.
Important
This is a Public Preview API. It may be changed or removed at any time.-
Creates a new arrival detection engine instance.
Declaration
Swift
public convenience init()
-
Checks if the driver has reached the destination.
Throws
NavigationProcessingError.routeDataMissingif there is noactiveRouteon theNavigationSnapshot.Declaration
Swift
public func hasArrivedAtDestination(navigationSnapshot: NavigationSnapshot) throws -> DestinationArrivalStatusParameters
navigationSnapshotA snapshot of the current route navigation session.
Return Value
A
DestinationArrivalStatuswith information about whether the user has arrived. -
Checks the arrival state of the next waypoint based on the
NavigationSnapshot.Throws
An error if the arrival status cannot be determined.Declaration
Swift
public func hasArrivedAtWaypoint( waypoint: RouteStop, navigationSnapshot: NavigationSnapshot ) throws -> WaypointStatusParameters
waypointThe waypoint to check for arrival status.
navigationSnapshotA snapshot of the current route navigation session.
Return Value
A
WaypointStatuswith information about whether the user has arrived at the waypoint. -
Resets the engine.
Warning
This method has not been implemented yet.Declaration
Swift
public func reset()