Structures

The following structures are available globally.

  • Arrival check status class.

    Important

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

    Declaration

    Swift

    public struct DestinationArrivalStatus
  • Important

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

    Declaration

    Swift

    public struct WaypointArrivalStatus
  • ActiveRouteData stores the active route and an optional better route proposal.

    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 struct ActiveRouteData

NavigationSnapshot

  • Navigation snapshot containing information about the state of the trip at a certain moment

    Important

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

    Declaration

    Swift

    public struct NavigationSnapshot
  • Keeps state of currently followed route’s waypoints, provide methods to change this state.

    Important

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

    Declaration

    Swift

    public struct RouteWaypointsState
  • RoutePlan specifies all required parameters for a single route navigation session.

    Important

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

    Declaration

    Swift

    public struct RoutePlan

GuidanceAnnouncement

  • Fine-grained announcement points, each with its own unique id, message and type.

    Important

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

    Declaration

    Swift

    public struct GuidanceAnnouncement : Equatable

AnnouncementGenerationParams

  • Class enclosing parameters passed to the AnnouncementGenerator

    Important

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

    Declaration

    Swift

    public struct AnnouncementGenerationParams

Guidance

LaneGuidanceInfo

  • Class enclosing the lane guidance event type and the current LaneGuidance instance.

    Important

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

    Declaration

    Swift

    public struct LaneGuidanceInfo
  • Data needed for generation of announcement message.

    Declaration

    Swift

    public struct AnnouncementData

NativeVerbalMessageGenerator

  • NativeVerbalMessageGenerator conforms to VerbalMessageGenerator and generates the required verbal messages using the C++ functional enabler.

    Important

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

    Declaration

    Swift

    public struct NativeVerbalMessageGenerator : VerbalMessageGenerator
  • Announcement audio message.

    See more

    Declaration

    Swift

    public struct VerbalMessage

LocationContext

  • LocationContext provides information about the driver’s location, which has been matched against the road network.

    Important

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

    Declaration

    Swift

    public struct LocationContext : Equatable

SpeedLimit

  • Important

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

    Declaration

    Swift

    public struct SpeedLimit : Equatable

NavigationPlan

  • NavigationPlan specifies all required parameters for a navigation session.

    Important

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

    Declaration

    Swift

    public struct NavigationPlan
  • Important

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

    Declaration

    Swift

    public struct RoutePointProgress
  • The RouteProgress class provides information about the driver’s progress along the route.

    See more

    Declaration

    Swift

    public struct RouteProgress
  • Important

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

    Declaration

    Swift

    public struct RouteReplanParameters

RouteReplanningEngineOptions

SimpleEngineCalcResult

  • Important

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

    Declaration

    Swift

    public struct SimpleEngineCalcResult
  • Has information about the city

    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 struct CityElement : HorizonElement

GeneralRoadElements

  • Has information about the road itself

    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 struct GeneralRoadElements : HorizonElement

HorizonResult

  • 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 struct HorizonResult

HorizonOptions

  • Has information about what information is required for HorizonEngine to deliver.

    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 struct HorizonOptions

MainPathOptions

  • Option parameters for searching on the main path.

    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 struct MainPathOptions

SubPathOptions

  • Option parameters for subpaths.

    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 struct SubPathOptions

HorizonSnapshot

  • 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 struct HorizonSnapshot

Path

  • 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 struct Path : Equatable

HorizonPosition

  • 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 struct HorizonPosition

SpeedLimits

  • Element with Speed limit information.

    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 struct SpeedLimits : HorizonElement
  • Has information about the street

    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 struct StreetElement : HorizonElement