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.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.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.Declaration
Swift
public struct ActiveRouteData
-
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.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.Declaration
Swift
public struct RoutePlan
-
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.Declaration
Swift
public struct GuidanceAnnouncement : Equatable
-
The instance enclosing parameters passed to the
AnnouncementGenerator
.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct AnnouncementGenerationParams
-
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.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.Declaration
Swift
public struct GuidanceParams
-
Guidance Instruction indicating arrival at the destination.
Important
This is a Public Preview API. It may be changed or removed at any time.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.Declaration
Swift
public struct BorderCrossing
-
Instruction indicating an upcoming border crossing.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct BorderCrossingGuidanceInstruction : GuidanceInstruction
-
Country information.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct CountryInfo
extension CountryInfo: Equatable
-
Guidance Instruction indicating departure from the origin.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct DepartureGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating entering a vehicle transportation service through a terminal.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct EnterAutoTransportGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating entering a carpool lane by changing lanes.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct EnterCarpoolLaneGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating exiting a vehicle transportation service through a terminal.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ExitAutoTransportGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating exiting a carpool lane by changing lanes.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ExitCarpoolLaneGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating taking a highway exit.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ExitHighwayGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating an exit from a roundabout.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ExitRoundaboutGuidanceInstruction : GuidanceInstruction
-
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.Declaration
Swift
public struct FollowGuidanceInstruction : GuidanceInstruction
-
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.Declaration
Swift
public struct ForkGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating a turn which is legally required.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct MandatoryTurnGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating a merge onto another road.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct MergeGuidanceInstruction : GuidanceInstruction
-
Road information relating to a
GuidanceInstruction
.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RoadInformation
extension RoadInformation: Equatable
-
Guidance Instruction indicating an upcoming roundabout.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RoundaboutGuidanceInstruction : GuidanceInstruction
-
Signpost information for a
GuidanceInstruction
.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct Signpost
extension Signpost: Equatable
-
Guidance Instruction indicating changing highways by following an exit ramp.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct SwitchHighwayGuidanceInstruction : GuidanceInstruction
-
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.Declaration
Swift
public struct TollgateGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating the driver should turn around when it is possible.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct TurnAroundWhenPossibleGuidanceInstruction : GuidanceInstruction
-
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.Declaration
Swift
public struct TurnGuidanceInstruction : GuidanceInstruction
-
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.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.Declaration
Swift
public struct LaneGuidance
-
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.Declaration
Swift
public struct LaneGuidanceUpdate
-
Defines types of unit system handling.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct UnitSystemType : Equatable
-
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.Declaration
Swift
public struct LocationContext : Equatable
-
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct SpeedLimit : Equatable
-
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.Declaration
Swift
public struct MapMatchingResult
-
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.Declaration
Swift
public struct NavigationOptions
-
The RouteProgress class provides information about the driver’s progress along the route.
See moreDeclaration
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.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.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
-
The options used for
TomTomRouteReplanningEngine
configurationImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RouteReplanningEngineOptions
-
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct SimpleEngineCalcResult
-
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 HorizonSnapshot