HereSDKRouteRequest

@interface HereSDKRouteRequest : NSObject <NSCopying>

Route Request

  • An array of points used for the route request

    points.firstObject = route start points.lastObject = route end

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSArray<CLLocation *> *_Nonnull points;

    Swift

    var points: [CLLocation] { get }

  • A Boolean flag indicating whether multiple routes should be produced for the route request if available.

    Default is NO.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL requestAlternativeRoutes;

    Swift

    var requestAlternativeRoutes: Bool { get set }

  • The type of transport to which the route should apply

    Default is HereSDKRouteProfileCar.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) HereSDKRouteProfile routeProfile;

    Swift

    var routeProfile: HereSDKRouteProfile { get set }

  • The route measurement units (Metric or Imperial)

    Default is HereSDKRouteMeasurementTypeMetric.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
    HereSDKRouteMeasurementType routeMeasurementType;

    Swift

    var routeMeasurementType: HereSDKRouteMeasurementType { get set }

  • BCP47 language code to use for text instructions. An error is returned if there are no matching supported languages. Optional; defaults to en-us.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) NSString *language;

    Swift

    var language: String? { get set }

  • Return the route request object that contains at least two locations (the start and end points) of the route. This parameter must not be nil.

    Declaration

    Objective-C

    - (nullable instancetype)initWithPoints:(nonnull NSArray<CLLocation *> *)points;

    Swift

    init?(points: [CLLocation])

    Parameters

    points

    which contain the location of the route

    Return Value

    A new HereSDKRouteRequest object or nil, if points parameter is invalid.

  • Return the route request object that contains the start destination and end destination of the route. Those parameters must not be nil.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithStart:(nonnull CLLocation *)start
                               andEnd:(nonnull CLLocation *)end;

    Swift

    init(start: CLLocation, andEnd end: CLLocation)

    Parameters

    start

    start destination
    end

    end destination

    Return Value

    A new HereSDKRouteRequest object