TomTom SDK for iOS RouteAddedReason

RouteAddedReason

public struct RouteAddedReason : RawRepresentable, Hashable

Defines the reasons why a route was added to the navigation session.

Important

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

  • Creates an instance of a custom RouteAddedReason. Returns nil if the raw value overrides a type created by TomTom.

    Declaration

    Swift

    public init?(rawValue: String)

  • Route added due to user deviation from the previous route.

    Declaration

    Swift

    public static let deviated: RouteAddedReason

  • Route added due to a blockage on the previous route.

    Declaration

    Swift

    public static let avoidBlockage: RouteAddedReason

  • Route added because the previous route itinerary became unreachable.

    Declaration

    Swift

    public static let withinRange: RouteAddedReason

  • Route added because it is proposed as a better route.

    Declaration

    Swift

    public static let betterRouteProposed: RouteAddedReason

  • Route added at the start of the navigation. Note, if the navigation is started with multiple routes they are added one at a time with the reason navigationStarted.

    Declaration

    Swift

    public static let navigationStarted: RouteAddedReason

  • Route added due to a manual navigation update using the TomTomNavigation.update method.

    Declaration

    Swift

    public static let manuallyUpdated: RouteAddedReason

  • Route added due to a language change. A change in the TomTomNavigation.preferredLanguage property triggers a route replan based on the new language preference.

    Declaration

    Swift

    public static let languageChanged: RouteAddedReason

  • The raw string of any predefined or custom RouteAddedReason

    Declaration

    Swift

    public let rawValue: String