Structures

The following structures are available globally.

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

ArrivalInstruction

EnterAutoTransportInstruction

ExitAutoTransportInstruction

BorderCrossingInstruction

EnterCarpoolLaneInstruction

ExitCarpoolLaneInstruction

BorderCrossing

  • Indicates a border crossing between two countries.

    See more

    Declaration

    Swift

    public struct BorderCrossing

Country

  • Country information.

    See more

    Declaration

    Swift

    public struct Country : Equatable

DepartureInstruction

FollowInstruction

ForkInstruction

ExitHighwayInstruction

SwitchHighwayInstruction

MandatoryTurnInstruction

MergeInstruction

PhoneticString

  • Represents a phonetic string.

    See more

    Declaration

    Swift

    public struct PhoneticString : Equatable

Phonetics

Road

  • Road information at a given point on a Route.

    See more

    Declaration

    Swift

    public struct Road : Equatable

RoadShield

  • Represents a road shield.

    See more

    Declaration

    Swift

    public struct RoadShield : Equatable

ExitRoundaboutInstruction

RoundaboutInstruction

TextWithPhonetics

  • Represents a localized string with optional phonetics information.

    See more

    Declaration

    Swift

    public struct TextWithPhonetics : Equatable

TollgateInstruction

TurnInstruction

TurnAroundWhenPossibleInstruction

WaypointInstruction

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

Route

  • The Route class provides information about the navigation route.

    Important

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

    Declaration

    Swift

    public struct Route : CustomStringConvertible

RouteLeg

  • Represents information about a part of a Route

    Contains a list of Instructions for all the maneuvers along the route leg.

    Important

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

    Declaration

    Swift

    public struct RouteLeg

RouteModificationHistory

  • Information about the route creation and the last update.

    Important

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

    Declaration

    Swift

    public struct RouteModificationHistory

RouteTimestamp

  • Information about route creation or modification time.

    Important

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

    Declaration

    Swift

    public struct RouteTimestamp

RoutePoint

  • Represents a route point 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 RoutePoint
  • The CarTrain struct contains information about a part of the route that goes by car train.

    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.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    public struct FerrySection : Section, SectionInitiable
  • The Lane class provides information about the lane on the road.

    See more

    Declaration

    Swift

    public struct Lane
  • 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
  • Represents CLLocationCoordinate2D on the Route with information about the distance from the start and the position of the start coordinate.

    Important

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

    Declaration

    Swift

    public struct LaneSectionRoutePoint
  • The LowEmissionZoneSection struct contains information about a part of the route that crosses a low emission zone.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    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.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    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.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    public struct TrafficSection : Section
  • The TunnelSection struct contains information about a part of the route that goes through a tunnel.

    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.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    Important

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

    Declaration

    Swift

    public struct Segment

Signpost

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

    See more

    Declaration

    Swift

    public struct Signpost

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
  • Represents information about the cause of a traffic event.

    See more

    Declaration

    Swift

    public struct Cause
  • Tec

    The Tec class contains details of a traffic event.

    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