TomTomSDKRoutePlanner

  • Represents the ‘extendedRouteRepresentation’ parameter values in a Request to the Routing API.

    See more

    Declaration

    Swift

    public enum ExtendedRouteRepresentation : CaseIterable
  • Specifies options related to alternative routes.

    Note

    Supporting points which are used for reconstructing a route and for calculating zero or more alternative routes to this reference route is part of RouteLegOptions
    See more

    Declaration

    Swift

    public struct AlternativeRoutesOptions
  • Represents the ‘alternativeType’ parameter in a Request to the Routing API.

    See more

    Declaration

    Swift

    public enum AlternativeType
  • Specifies whether to include announcement points in instructions. Supported only in routing with extended guidance.

    Note

    This option is not supported with the Orbis map.
    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
    public enum AnnouncementPoints
  • Road side on arrival preference for waypoints and destination.

    See more

    Declaration

    Swift

    public enum ArrivalSidePreference
  • Specifies whether to include extended sections such as road shield, lane, and speed limit sections in the route response,

    See more

    Declaration

    Swift

    public enum ExtendedSections
  • List of errors that can be thrown during the creation of GuidanceOptions.

    See more

    Declaration

    Swift

    public enum GuidanceOptionError : Error, Equatable
    extension GuidanceOptionError: LocalizedError
  • Represents the ‘instructionsType’ parameter in a request to the Routing API.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
    public enum InstructionType
  • Typealias for OnlineAPIVersion.

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
    public typealias OnlineApiVersion = OnlineAPIVersion
  • GuidanceVersion defines the Guidance API version to be used.

    See more

    Declaration

    Swift

    public enum OnlineAPIVersion : Int
  • Specifies whether to include progress points (travel time and distance points) in the response.

    See more

    Declaration

    Swift

    public enum ProgressPoints
  • Specifies whether to include road shield references into the external road shields atlas. If this parameter is set to all, the Instructions in route response contain RoadShield.reference that refers to the road shields of the next significant road segment after the maneuver. This refrence can then be used to decide upon the correct road shield image.

    See more

    Declaration

    Swift

    public enum RoadShieldReferences
  • Represents types of sections of the route

    See more

    Declaration

    Swift

    public enum SectionType : CaseIterable
  • A data type that contains input data for the advanceGuidanceProgress method of the RoutePlanner

    See more

    Declaration

    Swift

    public struct RouteIncrementOptions
  • RouteInformationMode defines how much guidance information (instructions and lane guidance) is returned with the route from the RoutePlanner.planRoute() function.

    See more

    Declaration

    Swift

    public enum RouteInformationMode
  • Options specific for concrete leg.

    See more

    Declaration

    Swift

    public struct RouteLegOptions
  • RoutePlanner protocol

    See more

    Declaration

    Swift

    public protocol RoutePlanner