TomTom SDK for iOS ArrivalDetectionEngine

ArrivalDetectionEngine

public protocol ArrivalDetectionEngine : ManageableEngine

Engine responsible for detecting arrival at the destination.

Important

This is a Public Preview API. It may be changed or removed at any time.

  • Performs the arrival at destination check.

    Throws

    An error if the arrival status cannot be determined.

    Declaration

    Swift

    func hasArrivedAtDestination(navigationSnapshot: NavigationSnapshot) throws -> DestinationArrivalStatus

    Parameters

    navigationSnapshot

    a snapshot of the current route navigation session.

    Return Value

    Arrival check status. True if the driver has arrived at the destination, false otherwise.

  • Performs the arrival at waypoint check.

    Throws

    An error if the arrival status cannot be determined.

    Declaration

    Swift

    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

    Arrival check status. True if the driver has passed a waypoint with a route point id, false otherwise.