TTRouteQueryBuilder

Objective-C

@interface TTRouteQueryBuilder : TTCommonQueryBuilder <TTRouteQueryBuilder *>

Swift

class TTRouteQueryBuilder : TTCommonQueryBuilder<TTRouteQueryBuilder>

TTRouteQueryBuilder

  • Declaration

    Objective-C

    + (TTRouteQueryBuilder *_Nonnull)
    createWithDest:(CLLocationCoordinate2D)destPosition
           andOrig:(CLLocationCoordinate2D)origPosition;

    Swift

    class func create(withDest destPosition: CLLocationCoordinate2D, andOrig origPosition: CLLocationCoordinate2D) -> TTRouteQueryBuilder

    Parameters

    destPosition

    The map coordinate whose geographical information your destination position.
    origPosition

    The map coordinate whose geographical information your start position.

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withInstructionsType:
    (TTOptionInstructionsType)instructionsType;

    Swift

    func withInstructionsType(_ instructionsType: TTOptionInstructionsType) -> TTRouteQueryBuilder

    Parameters

    instructionsType

    Guidance instructions will be returned

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withLang:(NSString *_Nonnull)language;

    Swift

    func withLang(_ language: String) -> TTRouteQueryBuilder

    Return Value

    TTSearchQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withArriveAt:(NSDate *_Nonnull)arriveAt;

    Swift

    func withArriveAt(_ arriveAt: Date) -> TTRouteQueryBuilder

    Parameters

    arriveAt

    The date and time of arrival at the destination point.

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withMaxAlternatives:
    (NSUInteger)maxAlternatives;

    Swift

    func withMaxAlternatives(_ maxAlternatives: UInt) -> TTRouteQueryBuilder

    Parameters

    maxAlternatives

    Number of desired alternative routes to be calculated.

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withComputeBestOrder:(BOOL)isComputeBestOrder;

    Swift

    func withComputeBestOrder(_ isComputeBestOrder: Bool) -> TTRouteQueryBuilder

    Parameters

    isComputeBestOrder

    The maximum allowed number of waypoints is 50, reduced to 20

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withRouteRepresentation:
    (NSString *_Nonnull)routeRepresentation;

    Swift

    func withRouteRepresentation(_ routeRepresentation: String) -> TTRouteQueryBuilder

    Parameters

    routeRepresentation

    Specifies the representation of the set of routes provided as response.

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withComputeTravelTimeFor:
    (NSString *_Nonnull)computeTravelTimeFor;

    Swift

    func withComputeTravelTime(for computeTravelTimeFor: String) -> TTRouteQueryBuilder

    Parameters

    computeTravelTimeFor

    Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withVehicleHeading:(NSUInteger)vehicleHeading;

    Swift

    func withVehicleHeading(_ vehicleHeading: UInt) -> TTRouteQueryBuilder

    Parameters

    vehicleHeading

    The directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction.

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withMinDeviationDistance:
    (NSUInteger)minDeviationDistance;

    Swift

    func withMinDeviationDistance(_ minDeviationDistance: UInt) -> TTRouteQueryBuilder

    Parameters

    minDeviationDistance

    All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt.

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withMinDeviationTime:
    (NSUInteger)minDeviationTime;

    Swift

    func withMinDeviationTime(_ minDeviationTime: UInt) -> TTRouteQueryBuilder

    Parameters

    minDeviationTime

    All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt.

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withSectionType:(TTSectionType)sectionType;

    Swift

    func withSectionType(_ sectionType: TTSectionType) -> TTRouteQueryBuilder

    Parameters

    sectionType

    Specifies which of the section types is reported in the route response.

    Return Value

    TTRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)
    withSupportingPoints:(CLLocationCoordinate2D *_Nonnull)supportingPoints
                   count:(NSUInteger)count;

    Swift

    func withSupportingPoints(_ supportingPoints: UnsafeMutablePointer<CLLocationCoordinate2D>, count: UInt) -> TTRouteQueryBuilder

    Parameters

    supportingPoints

    A list of base route points to be used as input for route reconstruction.

    Return Value

    TTRouteQueryBuilder

  • Specifies HTTP headers for the Request. It can be used to trace a call.

    Declaration

    Objective-C

    - (TTRouteQueryBuilder *_Nonnull)withHTTPHeaders:
    (TTHTTPHeaders *_Nonnull)headers;

    Swift

    func withHTTPHeaders(_ headers: TTHTTPHeaders) -> TTRouteQueryBuilder

    Parameters

    headers

    HTTP headers for the Request

    Return Value

    TTMatrixRouteQueryBuilder

  • Declaration

    Objective-C

    - (TTRouteQuery *_Nonnull)build;

    Swift

    func build() -> TTRouteQuery

    Return Value

    TTRouteQuery