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

  • 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.

    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

Guidance

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

    Important

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

    Declaration

    Swift

    public struct Guidance
  • Class enclosing parameters passed to the GuidanceEngineInstance

    Important

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

    Declaration

    Swift

    public struct GuidanceParams

ArrivalGuidanceInstruction

  • Guidance Instruction indicating 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 struct ArrivalGuidanceInstruction : GuidanceInstruction
  • Indicates a border crossing between two countries.

    Important

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

    Declaration

    Swift

    public struct BorderCrossing

BorderCrossingGuidanceInstruction

CountryInfo

  • Country information.

    Important

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

    Declaration

    Swift

    public struct CountryInfo
    extension CountryInfo: Equatable

DepartureGuidanceInstruction

EnterAutoTransportGuidanceInstruction

EnterCarpoolLaneGuidanceInstruction

ExitCarpoolLaneGuidanceInstruction

ExitHighwayGuidanceInstruction

ExitRoundaboutGuidanceInstruction

FollowGuidanceInstruction

  • Guidance Instruction indicating that the current road should be followed for some distance.

    Important

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

    Declaration

    Swift

    public struct FollowGuidanceInstruction : GuidanceInstruction

ForkGuidanceInstruction

  • Guidance Instruction indicating an upcoming fork in the road.

    Important

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

    Declaration

    Swift

    public struct ForkGuidanceInstruction : GuidanceInstruction

MandatoryTurnGuidanceInstruction

MergeGuidanceInstruction

  • Guidance Instruction indicating a merge onto another road.

    Important

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

    Declaration

    Swift

    public struct MergeGuidanceInstruction : GuidanceInstruction

RoadInformation

  • Road information relating to a GuidanceInstruction.

    Important

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

    Declaration

    Swift

    public struct RoadInformation
    extension RoadInformation: Equatable

RoundaboutGuidanceInstruction

Signpost

  • Signpost information for a GuidanceInstruction.

    Important

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

    Declaration

    Swift

    public struct Signpost
    extension Signpost: Equatable

SwitchHighwayGuidanceInstruction

TollgateGuidanceInstruction

  • Guidance instruction indicating the driver is approaching a tollgate or ETC terminal.

    Important

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

    Declaration

    Swift

    public struct TollgateGuidanceInstruction : GuidanceInstruction

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.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    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.

    Important

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

    Declaration

    Swift

    public struct LaneGuidance

LaneGuidanceUpdate

  • Holds information about LaneGuidance and whether it is starting or ending.

    Important

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

    Declaration

    Swift

    public struct LaneGuidanceUpdate

UnitSystemType

  • Defines types of unit system handling.

    Important

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

    Declaration

    Swift

    public struct UnitSystemType : Equatable

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

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

NavigationOptions

  • NavigationOptions 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 NavigationOptions
  • 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 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
  • Important

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

    Declaration

    Swift

    @available(*, deprecated, message: "RouteReplanParameters is deprecated. Consider replacing with NavigationSnapshot, RouteReplanner and ReplanRequestReason")
    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

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