TrafficRouter | iOS SDK | 2GIS Documentation
iOS SDK
Maps
Search
Navigation
On-Premise
Urbi Pro
CityLens
Account

TrafficRouter

Interface for finding a route, taking into account traffic jam data.

Extends: Hashable
public static func == (lhs: TrafficRouter, rhs: TrafficRouter) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init(
    context: Context
)
Parameters
context
Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters
hasher
Hasher

Hasher to use when combining the components of this instance.

public func findRoute(
    startPoint: RouteSearchPoint,
    finishPoint: RouteSearchPoint,
    routeSearchOptions: RouteSearchOptions,
    intermediatePoints: [RouteSearchPoint] = []
) -> Future<[TrafficRoute]>

Searches the route according to the specified parameters.

Parameters
startPoint
RouteSearchPoint

Starting point of route.

finishPoint
RouteSearchPoint

Finish point of the route.

routeSearchOptions
RouteSearchOptions

Route search parameters.

intermediatePoints
RouteSearchPoint[]

Intermediate points for a route in the same order as the points are set in the vector.

public func findBriefRouteInfos(
    searchPoints: [BriefRouteInfoSearchPoints],
    routeSearchOptions: RouteSearchOptions
) -> Future<[BriefRouteInfo?]>

Searches for basic route information for the corresponding set of search points.
If basic information for any of the point pairs is not found, the element with the corresponding index in the returned result will be set to nil.

Parameters
searchPoints
BriefRouteInfoSearchPoints[]

Searches a set of search points for basic route information.

routeSearchOptions
RouteSearchOptions

Route search parameters.

Returns
BriefRouteInfo<[?]>

Future with basic route set information, corresponding to a set of search points, or SimpleError exception in case of an error.

Properties
var truckPassZonePasses
Future<[TruckPassZonePass]>

Returns a list of all supported passes that allow truck traffic within the pass zones.