MQRouteOptions

@interface MQRouteOptions : MQBaseRouteOptions

An object that describes the route options, such as avoiding toll/highways, given to the MQRouteService when requesting new routes

  • Allows: enable highways to be on route (default) Avoids: does not guarantee highways will be avoided if alternate route paths are too lengthy or not possible, or roads that contain these attributes are very short Disallows: guarantees highways will not be allowed as part of the route

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) MQRouteOptionType highways;

    Swift

    var highways: MQRouteOptionType { get set }
  • Allows: enable toll roads to be on route (default) Avoids: does not guarantee toll roads will be avoided if alternate route paths are too lengthy or not possible, or roads that contain these attributes are very short Disallows: guarantees toll roads will not be allowed as part of the route

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) MQRouteOptionType tolls;

    Swift

    var tolls: MQRouteOptionType { get set }
  • Allows: enable ferries to be on route (default) Avoids: does not guarantee ferries will be avoided if alternate route paths are too lengthy or not possible, or roads that contain these attributes are very short Disallows: guarantees ferries will not be allowed as part of the route

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) MQRouteOptionType ferries;

    Swift

    var ferries: MQRouteOptionType { get set }
  • Allows: enable unpaved roads to be on route (default) Avoids: does not guarantee unpaved roads will be avoided if alternate route paths are too lengthy or not possible, or roads that contain these attributes are very short Disallows: guarantees unpaved roads will not be allowed as part of the route

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) MQRouteOptionType unpaved;

    Swift

    var unpaved: MQRouteOptionType { get set }
  • Allows: enable country crossing roads to be on route (default) Avoids: does not guarantee country crossing roads will be avoided if alternate route paths are too lengthy or not possible, or roads that contain these attributes are very short Disallows: guarantees country crossing roads will not be allowed as part of the route

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) MQRouteOptionType internationalBorders;

    Swift

    var internationalBorders: MQRouteOptionType { get set }
  • Allows: enable seasonal roads to be on route (default) Avoids: does not guarantee seasonal roads with these attributes will be avoided if alternate route paths are too lengthy or not possible, or roads that contain these attributes are very short Disallows: guarantees seasonal roads with these attributes will not be allowed as part of the route

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) MQRouteOptionType seasonalClosures;

    Swift

    var seasonalClosures: MQRouteOptionType { get set }
  • The maximum number of different routes that will be returned in the response. The number of routes actually returned may be less than the maximum number of routes specified. The default value for max routes is 3.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSUInteger maxRoutes;

    Swift

    var maxRoutes: UInt { get set }
  • System of measurement for all the display texts. This will control if the prompts are in miles (feet) or kilometers. This doesn’t affect pure (not part of a text) distances returned by navigation engine, which are always in the metric system.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        MQSystemOfMeasurement systemOfMeasurementForDisplayText;

    Swift

    var systemOfMeasurementForDisplayText: MQSystemOfMeasurement { get set }
  • Language (locale) for routing prompts, nil defaults to en_US

    Declaration

    Objective-C

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

    Swift

    var language: String? { get set }
  • Rally mode tells the MQRouteService to ignore ignore traffic, time restrictions, and road closures. This can be used for parades and car rallies or to plan a route without consideration for current conditions, but still including the current condition data.

    Declaration

    Objective-C

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

    Swift

    var rallyMode: Bool { get set }