TomTom SDK for iOS RouteRemovedReason

RouteRemovedReason

public struct RouteRemovedReason : RawRepresentable, Hashable

Defines the reasons why a route was removed from 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 RouteRemovedReason. Returns nil if the raw value overrides a type created by TomTom.

    Declaration

    Swift

    public init?(rawValue: String)

  • Route removed because the user has manually updated the route. This removal reason is used when:

    • the navigation is updated using the TomTomNavigation.update method.
    • a better route proposal has been selected using the TomTomNavigation.acceptProposedRoute method or by decide by steering.

    Declaration

    Swift

    public static let manual: RouteRemovedReason

  • Route removed due to automatic replan during navigation. This removal reason is used when:

    • There is a blockage on the route.
    • The route is out of range for the current vehicle properties.
    • The route is no longer being followed by the user. This includes any better routes proposed.
    • A better route proposal has been automatically selected, see BetterProposalAcceptanceMode.automatic
    • The language has changed, see TomTomNavigation.language

    Declaration

    Swift

    public static let automaticReplan: RouteRemovedReason

  • The raw string of any predefined or custom RouteRemovedReason

    Declaration

    Swift

    public let rawValue: String