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
  • Responsible for generation of Guidance and LaneGuidance related to upcoming road maneuvers.

    See more

    Declaration

    Swift

    public protocol GuidanceEngine : ManageableEngine
  • The protocol for a Guidance Instruction.

    Contains a set of attributes common to all GuidanceInstructions. It contains a set of default attributes common to all GuidanceInstruction‘s.

    e.g., 'Turn right’, ‘Keep left’, ‘Take the ferry’, ‘Take the motorway’, ‘Arrive’.

    Different types of GuidanceInstruction‘s 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 LocationContextProviderEngine 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 LocationContextProviderEngine : 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
  • The RouteProgressProviderEngine 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 RouteProgressProviderEngine : ManageableEngine
  • The RouteProjectionEngine is responsible for projecting the input route to obtain map references if they are not provided.

    Important

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

    Declaration

    Swift

    public protocol RouteProjectionEngine : ManageableEngine
  • 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 RouteProposalSelector

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
  • Defines the interface to horizon elements.

    Important

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

    Declaration

    Swift

    public protocol HorizonElement

HorizonAttributeData

  • Protocol that defines a horizon attribute data for onboard, online and hybrid implementations

    Important

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

    Declaration

    Swift

    public protocol HorizonAttributeData : AnyObject

HorizonPathPosition

  • Protocol that defines a horizon path osition for onboard, online and hybrid implementations

    Important

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

    Declaration

    Swift

    public protocol HorizonPathPosition

HorizonEngine

  • Defines the interface to the horizon engine. The horizon engine generates vehicle horizon data based on previously registered horizon subscription options, which define the length of the horizon paths and what map data is collected for these paths. The client of the horizon engine can register multiple sets of horizon subscription options and request the engine to provide horizon data for all or some of these sets of options. The client of the engine can also update the subscription by registering a new set of subscription options or unregistering a previously registered set.

    Important

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

    Declaration

    Swift

    public protocol HorizonEngine

PathSearchDistancePolicy

  • Interface to the path search policy. The path search policy specifies whether the horizon engine must search along the entire route or within a user-defined distance.

    Important

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

    Declaration

    Swift

    public protocol PathSearchDistancePolicy