TomTomArrivalDetectionEngine

public class TomTomArrivalDetectionEngine : ArrivalDetectionEngine

TomTomArrivalDetectionEngine 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.

Lifecycle

  • Creates a new arrival detection engine instance.

    Declaration

    Swift

    public convenience init()

Public

  • Checks if the driver has reached the destination.

    Throws

    NavigationProcessingError.routeDataMissing if there is no activeRoute on the NavigationSnapshot.

    Declaration

    Swift

    public func hasArrivedAtDestination(navigationSnapshot: NavigationSnapshot) throws -> DestinationArrivalStatus

    Parameters

    navigationSnapshot

    A snapshot of the current route navigation session.

    Return Value

    A DestinationArrivalStatus with 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
    -> WaypointArrivalStatus

    Parameters

    waypoint

    The waypoint to check for arrival status.
    navigationSnapshot

    A snapshot of the current route navigation session.

    Return Value

    A WaypointArrivalStatus with 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()