TomTom SDK for iOS NavigationStartError

NavigationStartError

public enum NavigationStartError : Error

NavigationStartError contains information about any problems that occur during navigation. The detailed meaning of each error is provided via the message variable.

Important

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

  • Occurs when the trip plan contains an invalid ID, such as the vehicle ID.

    Declaration

    Swift

    case invalidId

  • Occurs when trip planning fails for an unexpected reason.

    Declaration

    Swift

    case failed

  • Occurs when the request contains a parameter value outside its valid range.

    Declaration

    Swift

    case invalidRange

  • Occurs when no departure place is provided in the trip plan and the system does not have a current position.

    Declaration

    Swift

    case unknownStartingPoint

  • Occurs when there is an error in the communication to the routing service.

    Declaration

    Swift

    case communicationError

  • Occurs on a bad request: the routing request contains invalid or missing parameters.

    Declaration

    Swift

    case badRequest

  • Occurs when permission is denied: the API key used for online routing is not valid, or the rate limit has been exceeded.

    Declaration

    Swift

    case permissionDenied

  • Occurs when there has been a timeout in the routing service.

    Declaration

    Swift

    case serviceTimeout

  • Occurs when there has been an unknown error in the routing service.

    Declaration

    Swift

    case serviceError

  • Occurs when the onboard service fails to decode the route response.

    Declaration

    Swift

    case routeDecodingError

  • Occurs when no route has been found using the supplied parameters.

    Declaration

    Swift

    case routeNotFound

  • Declaration

    Swift

    public var message: String { get }