Structures

The following structures are available globally.

  • Important

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

    Declaration

    Swift

    public struct DestinationArrivalStatus
  • Holds arrival status to a unique waypoint.

    Important

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

    Declaration

    Swift

    public struct WaypointArrivalStatus

GuidanceAnnouncement

  • Guidance announcement relating to a maneuver during navigation. The announcement text message is provided in both Speech Synthesis Markup Language (SSML) and plain-text formats.

    See more

    Declaration

    Swift

    public struct GuidanceAnnouncement : Equatable

Guidance

  • Guidance update provided while navigating a route, including the list of upcoming instructions, guidance announcement and distance to the next maneuver.

    See more

    Declaration

    Swift

    public struct Guidance

ArrivalGuidanceInstruction

BorderCrossing

  • Indicates a border crossing between two countries.

    See more

    Declaration

    Swift

    public struct BorderCrossing

BorderCrossingGuidanceInstruction

Country

  • Country information.

    See more

    Declaration

    Swift

    public struct Country : Equatable

DepartureGuidanceInstruction

EnterAutoTransportGuidanceInstruction

EnterCarpoolLaneGuidanceInstruction

ExitCarpoolLaneGuidanceInstruction

ExitHighwayGuidanceInstruction

ExitRoundaboutGuidanceInstruction

FollowGuidanceInstruction

ForkGuidanceInstruction

MandatoryTurnGuidanceInstruction

MergeGuidanceInstruction

Road

RoundaboutGuidanceInstruction

Signpost

SwitchHighwayGuidanceInstruction

TollgateGuidanceInstruction

TurnAroundWhenPossibleGuidanceInstruction

TurnGuidanceInstruction

  • Guidance Instruction indicating a turn at a road junction.

    Important

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

    Declaration

    Swift

    public struct TurnGuidanceInstruction : GuidanceInstruction

WaypointGuidanceInstruction

  • Guidance Instruction indicating that a waypoint on the route is reached.

    See more

    Declaration

    Swift

    public struct WaypointGuidanceInstruction : GuidanceInstruction
  • Contains information about lane guidance.

    Lanes are stored in order from curb side to middle side. That is, in left-hand driving locales such as Japan, the lanes are ordered from left to right, while in right-hand driving locales such as the USA, the lanes are ordered from right to left.

    See more

    Declaration

    Swift

    public struct LaneGuidance

LaneGuidanceUpdate

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

MapMatchingResult

  • The MapMatchingResult provides information about the matched location and its details.

    Important

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

    Declaration

    Swift

    public struct MapMatchingResult
  • The RouteProgress class provides information about the driver’s 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 struct RouteProgress
  • Important

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

    Declaration

    Swift

    public struct RouteStopProgress
  • Represents a projected route with missing map reference data.

    Important

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

    Declaration

    Swift

    public struct ProjectedRoute
  • Describes part of the ProjectedRoute.

    Important

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

    Declaration

    Swift

    public struct ProjectedRouteSection

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.
    See more

    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
  • Describes a city on the horizon element.

    Important

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

    Declaration

    Swift

    public struct City : HorizonElement

GeneralRoadElements

  • Describes the general road properties on the horizon element.

    Important

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

    Declaration

    Swift

    public struct GeneralRoadElements : HorizonElement
  • POI

    Describes path geometry of the horizon element

    Important

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

    Declaration

    Swift

    public struct POI : HorizonElement
  • Describes path geometry of the horizon element

    Important

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

    Declaration

    Swift

    public struct PathGeometry : HorizonElement
  • Describes path geometry of the horizon element

    Important

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

    Declaration

    Swift

    public struct Region : HorizonElement
  • Describes path geometry of the horizon element

    Important

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

    Declaration

    Swift

    public struct SafetyLocation : HorizonElement

SpeedLimits

  • Element with Speed limit information.

    Important

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

    Declaration

    Swift

    public struct SpeedLimits : HorizonElement
  • Describes a street on the horizon element.

    Important

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

    Declaration

    Swift

    public struct Street : HorizonElement
  • Defines a Distance based path search policy

    Important

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

    Declaration

    Swift

    public struct ExplicitDistancePolicy : PathSearchDistancePolicy

HorizonResponse

  • A response from HorizonEngine. Contains a snapshot with horizon information and the options that where used to get it.

    Important

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

    Declaration

    Swift

    public struct HorizonResponse

HorizonOptions

  • Horizon subscription configuration. The client uses subscription options to define the extent of the paths in the horizon and the map attributes that are collected for these paths. A subscription configuration consists of search options, such as the path search distance and the path search time, as well as a set of types of horizon elements that the client is interested in. The search distance and time determine the length of the horizon paths. The set of horizon element types determines which map attributes will be collected for those paths.

    Important

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

    Declaration

    Swift

    public struct HorizonOptions
    extension HorizonOptions: Hashable

HorizonElementType

  • Defines the interface to horizon element types.

    Important

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

    Declaration

    Swift

    public struct HorizonElementType : RawRepresentable, Hashable

MainPathOptions

  • Horizon search options for the main path. Search options, such as the search distance and the search time, define the extent of the paths in the horizon. If both search time and search policy are non-null (i.e. the subscription specifies both a search time and a search distance) for the main path, the horizon engine will extend the main path until both time and distance have reached their limits. If the search time is null and the search policy is not null, the horizon engine will work with a default value of 0 seconds for the search time and will extend the main path based on the search distance directly specified by or derived from the search policy. If the search time is non-null and the search policy is null, the horizon engine will work with a default value of 0 centimeters for the search distance and will extend the main path based on the search time.

    Important

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

    Declaration

    Swift

    public struct MainPathOptions

SubPathOptions

  • Horizon search options for a sub-path level. Search options, such as the search distance and the search time, define the extent of the paths in the horizon. If both search time and search distance are non-null (i.e. the subscription specifies both a search time and a search distance) for a given sub-path level, the horizon engine will extend horizon sub-paths of that level until both time and distance have reached the limit. If the search time is null and the search distance is non-null for a given sub-path level, the horizon engine will work with a default value of 0 seconds for the search time and will extend sub-paths of that level based on the search distance. If the search time is non-null and the search distance is null for a given sub-path level, the horizon engine will work with a default value of 0 centimeters for the search distance and will extend sub-paths of that level based on the search time.

    Important

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

    Declaration

    Swift

    public struct SubPathOptions

HorizonSnapshot

  • Snapshot of the horizon provided by the horizon engine, based on a set of previously registered horizon subscription options. Subscription options define the extent of the paths in the horizon as well as which map attributes are collected for those paths.

    Important

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

    Declaration

    Swift

    public struct HorizonSnapshot

HorizonPath

  • Path in the horizon. The length of the path as well as which types of horizon elements it contains are determined by the horizon subscription options.

    Important

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

    Declaration

    Swift

    public struct HorizonPath : Equatable

HorizonPosition

  • Current position in the horizon.

    Important

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

    Declaration

    Swift

    public struct HorizonPosition