RouteResponse Structure Reference


                    
                    
                    foreignMembers

Declaration

Swift

public var foreignMembers: JSONObject

View Source on GitHub


                    
                    
                    httpResponse

The raw HTTP response from the Directions API.

Declaration

Swift

public let httpResponse: HTTPURLResponse?

View Source on GitHub


                    
                    
                    identifier

The unique identifier that the Mapbox Directions API has assigned to this response.

Declaration

Swift

public let identifier: String?

View Source on GitHub


                    
                    
                    routes

An array of Route objects sorted from most recommended to least recommended. A route may be highly recommended based on characteristics such as expected travel time or distance. This property contains a maximum of two Routes.

Declaration

Swift

public var routes: [Route]? { get set }

View Source on GitHub


                    
                    
                    waypoints

An array of Waypoint objects in the order of the input coordinates. Each Waypoint is an input coordinate snapped to the road and path network.

This property omits the waypoint corresponding to any waypoint in RouteOptions.waypoints that has Waypoint.separatesLegs set to true.

Declaration

Swift

public let waypoints: [Waypoint]?

View Source on GitHub


                    
                    
                    options

The criteria for the directions response.

Declaration

Swift

public let options: ResponseOptions

View Source on GitHub


                    
                    
                    credentials

The credentials used to make the request.

Declaration

Swift

public let credentials: Credentials

View Source on GitHub


                    
                    
                    created

The time when this RouteResponse object was created, which is immediately upon recieving the raw URL response.

If you manually start fetching a task returned by Directions.url(forCalculating:), this property is set to nil; use the URLSessionTaskTransactionMetrics.responseEndDate property instead. This property may also be set to nil if you create this result from a JSON object or encoded object.

This property does not persist after encoding and decoding.

Declaration

Swift

public var created: Date

View Source on GitHub


                    
                    
                    roadClassExclusionViolations

Managed array of RoadClasses restrictions specified to RouteOptions.roadClassesToAvoid which were violated during route calculation.

Routing engine may still utilize RoadClasses meant to be avoided in cases when routing is impossible otherwise.

Violations are ordered by routes from the routes array, then by a leg, step, and intersection, where RoadClasses restrictions were ignored. nil and empty return arrays correspond to nil and empty routes array respectively.

Declaration

Swift

public private(set) var roadClassExclusionViolations: [RoadClassExclusionViolation]? { get }

View Source on GitHub


                    
                    
                    init(from:)

Declaration

Swift

public init(from decoder: Decoder) throws

View Source on GitHub


                    
                    
                    encode(to:)

Declaration

Swift

public func encode(to encoder: Encoder) throws

View Source on GitHub


                    
                    
                    exclusionViolations(routeIndex:legIndex:)

Filters roadClassExclusionViolations lazily to search for specific leg and step.

Passing nil as legIndex will result in searching for all legs.

Declaration

Swift

public func exclusionViolations(routeIndex: Int, legIndex: Int? = nil) -> LazyFilterSequence<[RoadClassExclusionViolation]>

Parameters

`routeIndex`	Index of a route inside current `RouteResponse` to search in.
`legIndex`	Index of a leg inside related `Route`to search in.

Return Value

Lazy filtered array of RoadClassExclusionViolation under given indicies.

View Source on GitHub


                    
                    
                    exclusionViolations(routeIndex:legIndex:stepIndex:)

Filters roadClassExclusionViolations lazily to search for specific leg and step.

Passing nil as stepIndex will result in searching for all steps.

Declaration

Swift

public func exclusionViolations(routeIndex: Int, legIndex: Int, stepIndex: Int? = nil) -> LazyFilterSequence<[RoadClassExclusionViolation]>

Parameters

`routeIndex`	Index of a route inside current `RouteResponse` to search in.
`legIndex`	Index of a leg inside related `Route`to search in.
`stepIndex`	Index of a step inside given `Route`‘s leg.

Return Value

Lazy filtered array of RoadClassExclusionViolation under given indicies.

View Source on GitHub


                    
                    
                    exclusionViolations(routeIndex:legIndex:stepIndex:intersectionIndex:)

Filters roadClassExclusionViolations lazily to search for specific leg, step and intersection.

Passing nil as intersectionIndex will result in searching for all intersections of given step.

Declaration

Swift

public func exclusionViolations(routeIndex: Int, legIndex: Int, stepIndex: Int, intersectionIndex: Int?) -> LazyFilterSequence<[RoadClassExclusionViolation]>

Parameters

`routeIndex`	Index of a route inside current `RouteResponse` to search in.
`legIndex`	Index of a leg inside related `Route`to search in.
`stepIndex`	Index of a step inside given `Route`‘s leg.
`intersectionIndex`	Index of an intersection inside given `Route`‘s leg and step.

Return Value

Lazy filtered array of RoadClassExclusionViolation under given indicies.

View Source on GitHub