Protocols

The following protocols are available globally.

  • Engine responsible for detecting arrival at the destination.

    Important

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

    Declaration

    Swift

    public protocol ArrivalDetectionEngine : ManageableEngine

  • An NavigationConfiguration object defines the behaviour to use when start Navigation object.

    Important

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

    Declaration

    Swift

    public protocol NavigationConfiguration : RoutingServiceProvider

MainNavigationEngines

  • Important

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

    Declaration

    Swift

    public protocol MainNavigationEngines : AnyObject

  • Important

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

    Declaration

    Swift

    public protocol RouteNavigationEnginesProvider : AnyObject

  • Provides access to routingService

    Important

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

    Declaration

    Swift

    public protocol RoutingServiceProvider

EngineActions

  • EngineActions defines the actions and properties provided by the the navigation service.

    Important

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

    Declaration

    Swift

    public protocol EngineActions

  • The GuidanceEngine protocol defines functionality related to navigation guidance steps.

    Important

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

    Declaration

    Swift

    public protocol GuidanceEngine : ManageableEngine

AnnouncementGenerator

  • The AnnouncementGenerator protocol defines functionality for generating announcements during route navigation.

    Important

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

    Declaration

    Swift

    public protocol AnnouncementGenerator

  • The protocol for a basic Guidance Instruction contains information used to guide the driver during navigation. It contains a set of default attributes common to all GuidanceInstructions e.g., ‘Turn right’, ‘Keep left’, ‘Take the ferry’, ‘Take the motorway’, ‘Arrive’.

    Different types of GuidanceInstructions will implement this, and may add extra attributes specific to the Instruction type. e.g., TurnInstruction will contain turnAngleInDegrees and turnDirection

    Important

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

    Declaration

    Swift

    public protocol GuidanceInstruction

  • The LocationContextDetectionEngine protocol provides functionality related to information about a matched location.

    Important

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

    Declaration

    Swift

    public protocol LocationContextDetectionEngine : ManageableEngine

  • The ManageableEngine protocol provides functionality related to engine data management.

    Important

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

    Declaration

    Swift

    public protocol ManageableEngine

MapMatchingEngine

  • The MapMatchingEngine provides an interface for map matching functionality.

    Important

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

    Declaration

    Swift

    public protocol MapMatchingEngine : ManageableEngine

NavigationEngines

NavigationStartObserver

  • Important

    This is a Public Preview API. It may be changed or removed at any time. An observer to receive navigation start events.
    See more

    Declaration

    Swift

    public protocol NavigationStartObserver : Observer

NavigationMapMatchingObserver

  • Important

    This is a Public Preview API. It may be changed or removed at any time. An observer to receive navigation map matching events.
    See more

    Declaration

    Swift

    public protocol NavigationMapMatchingObserver : Observer

NavigationProgressObserver

  • Important

    This is a Public Preview API. It may be changed or removed at any time. An observer to receive navigation progress events.
    See more

    Declaration

    Swift

    public protocol NavigationProgressObserver : Observer

NavigationRouteObserver

  • Important

    This is a Public Preview API. It may be changed or removed at any time. An observer to receive navigation route events.
    See more

    Declaration

    Swift

    public protocol NavigationRouteObserver : Observer

NavigationGuidanceObserver

  • Important

    This is a Public Preview API. It may be changed or removed at any time. An observer to receive navigation guidance events.
    See more

    Declaration

    Swift

    public protocol NavigationGuidanceObserver : Observer

NavigationLocationContextObserver

  • Important

    This is a Public Preview API. It may be changed or removed at any time. An observer to receive navigation guidance events.
    See more

    Declaration

    Swift

    public protocol NavigationLocationContextObserver : Observer

NavigationArrivalObserver

  • Important

    This is a Public Preview API. It may be changed or removed at any time. An observer to receive navigation arrival events.
    See more

    Declaration

    Swift

    public protocol NavigationArrivalObserver : Observer

NavigationTripObserver

  • Important

    This is a Public Preview API. It may be changed or removed at any time. An observer to receive navigation trip events.
    See more

    Declaration

    Swift

    public protocol NavigationTripObserver : Observer

NavigationHorizonObserver

  • An observer to receive navigation horizon events.

    Warning

    This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged
    See more

    Declaration

    Swift

    public protocol NavigationHorizonObserver : Observer

NavigationErrorObserver

  • Important

    This is a Public Preview API. It may be changed or removed at any time. An observer to receive navigation error events.

    Declaration

    Swift

    public protocol NavigationErrorObserver : Observer

NavigationPlanActiveRouteDelegate

  • Important

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

    Declaration

    Swift

    public protocol NavigationPlanActiveRouteDelegate : AnyObject

NavigationPlanAddDelegate

  • Important

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

    Declaration

    Swift

    public protocol NavigationPlanAddDelegate : AnyObject

NavigationPlanRemoveDelegate

  • Important

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

    Declaration

    Swift

    public protocol NavigationPlanRemoveDelegate : AnyObject

NavigationPlanUpdateDelegate

  • Important

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

    Declaration

    Swift

    public protocol NavigationPlanUpdateDelegate : AnyObject

  • The RouteProgressDetectionEngine protocol provides functionality related to the calculation of progress along the route.

    Important

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

    Declaration

    Swift

    public protocol RouteProgressDetectionEngine : ManageableEngine

RouteProgressEngine

  • Important

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

    Declaration

    Swift

    public protocol RouteProgressEngine

  • Selector responsible for choosing the routes according to protocol’s adoptee expectations

    Important

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

    Declaration

    Swift

    public protocol BetterRouteSelector

  • Specifies how to handle requests which failed during replanning of a Route.

    Important

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

    Declaration

    Swift

    public protocol ReplanningRetryPolicy

RouteReplanningEngine

  • Engine responsible for replanning a route.

    Important

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

    Declaration

    Swift

    public protocol RouteReplanningEngine

  • The RouteTrackingEngine protocol provides functionality to determine if the driver is tracking the routes.

    Important

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

    Declaration

    Swift

    public protocol RouteTrackingEngine : ManageableEngine

TomTomNavigationDelegate

  • TomTomNavigationDelegate defines methods to provide information about events that occur during navigation.

    Important

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

    Declaration

    Swift

    public protocol TomTomNavigationDelegate : AnyObject

TomTomNavigationErrorDelegate

  • The TomTomNavigationErrorDelegate defines methods to report errors that occur during navigation.

    Important

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

    Declaration

    Swift

    public protocol TomTomNavigationErrorDelegate : AnyObject
    • Supplies the data store with all the context the store can use to perform an optimized update.

    Important

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

    Declaration

    Swift

    public protocol DataStoreUpdateContextEngine : ManageableEngine

SimpleEngineCommonCalcProtocol

  • Important

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

    Declaration

    Swift

    public protocol SimpleEngineCommonCalcProtocol

  • Common properties of HorizonElements.

    Warning

    This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.
    See more

    Declaration

    Swift

    public protocol HorizonElement

HorizonEngine

  • The HorizonEngine protocol is responsible for fetching horizon data.

    Warning

    This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.
    See more

    Declaration

    Swift

    public protocol HorizonEngine

HorizonElementType

  • Warning

    This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.

    Declaration

    Swift

    public protocol HorizonElementType