MPDirectionsQuery Class Reference

#include <MPDirectionsQuery.h>

Inheritance diagram for MPDirectionsQuery:

Instance Methods
(nonnull instancetype)	- init
(nonnull instancetype)	- initWithOrigin:destination:
(nonnull instancetype)	- initWithOriginPoint:destination:

Class Methods
(nonnull instancetype)	+ NS_UNAVAILABLE

Properties
NSArray< MPHighwayType > *	avoidWayTypes
MPLocation *	origin
MPLocation *	destination
NSDate *	arrival
NSDate *	departure
MPTravelMode	travelMode
NSArray< MPUserRole * > *	userRoles

Detailed Description

Directions query model.

Method Documentation

init

- (nonnull instancetype) init

initWithOrigin:destination:

- (nonnull instancetype) initWithOrigin:		(nonnull MPLocation *)	origin
destination:		(nonnull MPLocation *)	destination

Initialiser that takes locations as origin and destination.

Parameters

origin	Origin location.
destination	Destination location.

Returns

The directions query instance.

initWithOriginPoint:destination:

- (nonnull instancetype) initWithOriginPoint:		(nonnull MPPoint *)	origin
destination:		(nonnull MPPoint *)	destination

Initialiser that takes points as origin and destination.

Parameters

origin	Origin point.
destination	Destination point.

Returns

The directions query instance.

NS_UNAVAILABLE

+ (nonnull instancetype) NS_UNAVAILABLE

Property Documentation

arrival

- (NSDate*) arrival

readwritenonatomicstrong

Date for arrival. Setting both arrival and departure will result in undefined behavior.

avoidWayTypes

- (NSArray<MPHighwayType>*) avoidWayTypes

readwritenonatomicstrong

Way types that should be avoided when calculating routes. Supports any MPHighwayType.

departure

- (NSDate*) departure

readwritenonatomicstrong

Date for departure. Setting both arrival and departure will result in undefined behavior.

destination

- (MPLocation*) destination

readwritenonatomicstrong

Destination location.

origin

- (MPLocation*) origin

readwritenonatomicstrong

Origin location.

travelMode

- (MPTravelMode) travelMode

readwritenonatomicassign

Set travel mode. Default is walking.

userRoles

- (NSArray<MPUserRole*>*) userRoles

readwritenonatomicstrong

The user roles that the route should match.