Structures

The following structures are available globally.

  • Fine-grained announcement points, each with its own message, location and distance to the instruction point.

    Important

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

    Declaration

    Swift

    public struct Announcement
  • Represents information about the cause of a traffic event.

    Important

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

    Declaration

    Swift

    public struct Cause : Codable

Destination

  • Represents destination of the route received in response from route planning API

    Important

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

    Declaration

    Swift

    public struct Destination : RouteStop

PhoneticString

  • Represents a phonetic string.

    Important

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

    Declaration

    Swift

    public struct PhoneticString
    extension PhoneticString: Equatable

RoadInformation

  • Road information at a given point on a Route.

    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

RoadShield

  • Represents a road shield.

    Important

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

    Declaration

    Swift

    public struct RoadShield
    extension RoadShield: Equatable

Signpost

  • The Signpost class contains information about the signpost for the Instruction.

    Important

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

    Declaration

    Swift

    public struct Signpost

TextWithPhonetics

  • Represents a localized string with optional phonetics information.

    Important

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

    Declaration

    Swift

    public struct TextWithPhonetics
    extension TextWithPhonetics: Equatable

ArrivalInstruction

  • 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 ArrivalInstruction : Instruction

EnterAutoTransportInstruction

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

    Declaration

    Swift

    public struct EnterAutoTransportInstruction : Instruction

ExitAutoTransportInstruction

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

    Declaration

    Swift

    public struct ExitAutoTransportInstruction : Instruction

BorderCrossing

  • 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

BorderCrossingInstruction

  • Instruction indicating an upcoming border crossing.

    Important

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

    Declaration

    Swift

    public struct BorderCrossingInstruction : Instruction

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

EnterCarpoolLaneInstruction

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

    Declaration

    Swift

    public struct EnterCarpoolLaneInstruction : Instruction

ExitCarpoolLaneInstruction

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

    Declaration

    Swift

    public struct ExitCarpoolLaneInstruction : Instruction

DepartureInstruction

  • Instruction indicating departure from the origin.

    Important

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

    Declaration

    Swift

    public struct DepartureInstruction : Instruction

FollowInstruction

  • 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 FollowInstruction : Instruction

ForkInstruction

  • 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 ForkInstruction : Instruction

ExitHighwayInstruction

  • Instruction indicating a highway or motorway exit.

    Important

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

    Declaration

    Swift

    public struct ExitHighwayInstruction : Instruction

SwitchHighwayInstruction

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

    Declaration

    Swift

    public struct SwitchHighwayInstruction : Instruction

MandatoryTurnInstruction

  • Instruction indicating a turn which is legally required.

    Important

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

    Declaration

    Swift

    public struct MandatoryTurnInstruction : Instruction

MergeInstruction

  • Instruction indicating a merge to another road.

    Important

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

    Declaration

    Swift

    public struct MergeInstruction : Instruction

ExitRoundaboutInstruction

  • Instruction indicating exit from a roundabout.

    Important

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

    Declaration

    Swift

    public struct ExitRoundaboutInstruction : Instruction

RoundaboutInstruction

  • Instruction indicating a roundabout maneuver.

    Important

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

    Declaration

    Swift

    public struct RoundaboutInstruction : Instruction

TollgateInstruction

  • 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 TollgateInstruction : Instruction

TurnAroundWhenPossibleInstruction

  • Instruction indicating that 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.
    See more

    Declaration

    Swift

    public struct TurnAroundWhenPossibleInstruction : Instruction

TurnInstruction

  • 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 TurnInstruction : Instruction

WaypointInstruction

  • 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 WaypointInstruction : Instruction
  • The Lane class provides information about the lane on the road.

    Important

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

    Declaration

    Swift

    public struct Lane
  • Represents CLLocationCoordinate2D on the Route with information about the distance from the start and the position of the start coordinate.

    See more

    Declaration

    Swift

    public struct LaneSectionRoutePoint

Origin

  • Represents origin of the route received in response from route planning API

    Important

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

    Declaration

    Swift

    public struct Origin : RouteStop
  • Phonetic strings of all of the readable Instruction properties.

    Important

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

    Declaration

    Swift

    public struct Phonetics : Equatable
  • Contains information about the progress for specific points on the route.

    Important

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

    Declaration

    Swift

    public struct ProgressPoint

RouteCoordinate

  • Represents the route GeoCoordinate together with its distance offset along the route and estimated travel time.

    Important

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

    Declaration

    Swift

    public struct RouteCoordinate

RouteLeg

  • Represents information about a part of a Route

    Important

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

    Declaration

    Swift

    public struct RouteLeg
  • The CarTrain struct contains information about a part of the route that goes by car train.

    Important

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

    Declaration

    Swift

    public struct CarTrainSection : Section, SectionInitiable
  • The CarpoolSection struct contains information about a part of the route that involves a toll carpool.

    Important

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

    Declaration

    Swift

    public struct CarpoolSection : Section, SectionInitiable
  • The CountrySection struct contains information about a part of the route related to a country.

    Important

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

    Declaration

    Swift

    public struct CountrySection : Section
  • The FerrySection struct contains information about a part of the route that goes by ferry.

    Important

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

    Declaration

    Swift

    public struct FerrySection : Section, SectionInitiable
  • The LaneSection struct contains information about a part of the route related to lanes.

    Important

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

    Declaration

    Swift

    public struct LaneSection : Section
  • The MotorwaySection struct contains information about a part of the route that goes by motorway.

    Important

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

    Declaration

    Swift

    public struct MotorwaySection : Section, SectionInitiable
  • The PedestrianSection struct contains information about a part of the route related to the pedestrian.

    Important

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

    Declaration

    Swift

    public struct PedestrianSection : Section, SectionInitiable
  • The RoadShieldSection struct contains information about a part of the route going by roads with road shields.

    Important

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

    Declaration

    Swift

    public struct RoadShieldSection : Section, SectionInitiable
  • The SectionLocation struct contains information about the location of the section.

    Important

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

    Declaration

    Swift

    public struct SectionLocation
  • The Sections structure contains information about various sections on the route.

    Important

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

    Declaration

    Swift

    public struct Sections
  • The SpeedLimitSection struct represents a route section with speed limits available.

    Important

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

    Declaration

    Swift

    public struct SpeedLimitSection : Section
  • The TollRoadSection struct contains information about a part of the route going via a toll road.

    Important

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

    Declaration

    Swift

    public struct TollRoadSection : Section
  • The TollVignetteSection struct contains information about a part of the route where a toll vignette is required.

    Important

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

    Declaration

    Swift

    public struct TollVignetteSection : Section
  • The TrafficSection struct contains information about a part of the route related to traffic incidents.

    Important

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

    Declaration

    Swift

    public struct TrafficSection : Section
  • The TunnelSection struct contains information about a part of the route that goes through a tunnel. Important: This is a Public Preview API. It may be changed or removed at any time.

    See more

    Declaration

    Swift

    public struct TunnelSection : Section, SectionInitiable
  • The UnpavedSection struct contains information about a part of the route related to the unpaved road.

    See more

    Declaration

    Swift

    public struct UnpavedSection : Section, SectionInitiable
  • The UrbanSection struct contains information about a part of the route going through a city.

    Important

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

    Declaration

    Swift

    public struct UrbanSection : Section, SectionInitiable
  • The VehicleRestrictedSection struct represents a route section indicating a restriction for the vehicle used.

    Important

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

    Declaration

    Swift

    public struct VehicleRestrictedSection : Section
  • Represents a line between two RouteCoordinate.

    Important

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

    Declaration

    Swift

    public struct Segment

Summary

  • Summary of the whole route or the particular leg.

    Important

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

    Declaration

    Swift

    public struct Summary
  • Tec

    The Tec class contains details of a traffic event.

    Important

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

    Declaration

    Swift

    public struct Tec

Waypoint

  • Represents waypoint received in response from route planning API

    Important

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

    Declaration

    Swift

    public struct Waypoint : RouteStop
  • AnnouncementMessagesApplier transforms the announcements contained in routes. Adds voice messages and combines close announcements.

    Important

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

    Declaration

    Swift

    public struct AnnouncementMessagesApplier : AnnouncementMessagesApplierProtocol

VerbalMessageComposerInput

  • Inputs required for verbal message generation

    Important

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

    Declaration

    Swift

    public struct VerbalMessageComposerInput