SYRouteRequest Class Reference

Route request contains all information needed to compute different route types. More...

#import <SYRouteRequest.h>

Inheritance diagram for SYRouteRequest:

Collaboration diagram for SYRouteRequest:

Instance Methods
((unavailable("Use -[SYRouteRequest initWith...] instead.")	- __attribute__
(nonnull instancetype)	- initWithStart:destination:options:viaPoints:
(nonnull instancetype)	- initWithStart:destination:options:viaPoints:aetrProfile:
(nonnull instancetype)	- initWithStart:destination:options:viaPoints:evProfile:evPreferences:
(nonnull instancetype)	- initWithGuidedProfile:options:

Class Methods
(nonnull SYTask *)	+ deserializeRouteRequestFromJson:completion:
	This method will create SYRouteRequest from json. More...
((unavailable("Use -[SYRouteRequest initWith...] instead.")	+ __attribute__

Properties
SYWaypoint *	start
SYWaypoint *	destination
SYRoutingOptions *	options
NSArray< SYWaypoint * > *	viaPoints
SYEVProfile *	evProfile
SYEVPreferences *	evPreferences
SYAETRProfile *	aetrProfile
SYGuidedProfile *	guidedProfile

Detailed Description

Route request contains all information needed to compute different route types.

Method Documentation

deserializeRouteRequestFromJson:completion:

+ (nonnull SYTask*) deserializeRouteRequestFromJson:		(nonnull NSString *)	json
completion:		(nonnull SYRouteRequestCompletionBlock)	completion

This method will create SYRouteRequest from json.

Parameters

json	NSString object representation.
completion	callback with created SYRouteRequest, with SYSerializeState

__attribute__ [1/2]

- ((unavailable("Use -[SYRouteRequest initWith...] instead.") __attribute__

__attribute__ [2/2]

+ ((unavailable("Use -[SYRouteRequest initWith...] instead.") __attribute__

initWithStart:destination:options:viaPoints:

- (nonnull instancetype) initWithStart:		(nonnull SYWaypoint *)	start
destination:		(nonnull SYWaypoint *)	destination
options:		(nonnull SYRoutingOptions *)	options
viaPoints:		(nullable NSArray< SYWaypoint * > *)	viaPoints

initWithStart:destination:options:viaPoints:aetrProfile:

- (nonnull instancetype) initWithStart:		(nonnull SYWaypoint *)	start
destination:		(nonnull SYWaypoint *)	destination
options:		(nonnull SYRoutingOptions *)	options
viaPoints:		(nullable NSArray< SYWaypoint * > *)	viaPoints
aetrProfile:		(nonnull SYAETRProfile *)	aetrProfile

initWithStart:destination:options:viaPoints:evProfile:evPreferences:

- (nonnull instancetype) initWithStart:		(nonnull SYWaypoint *)	start
destination:		(nonnull SYWaypoint *)	destination
options:		(nonnull SYRoutingOptions *)	options
viaPoints:		(nullable NSArray< SYWaypoint * > *)	viaPoints
evProfile:		(nonnull SYEVProfile *)	evProfile
evPreferences:		(nullable SYEVPreferences *)	evPreferences

initWithGuidedProfile:options:

- (nonnull instancetype) initWithGuidedProfile:		(nonnull SYGuidedProfile *)	guidedProfile
options:		(nonnull SYRoutingOptions *)	options

Property Documentation

start

- (SYWaypoint*) start

readwritenonatomicstrong

destination

- (SYWaypoint*) destination

readwritenonatomicstrong

options

- (SYRoutingOptions*) options

readwritenonatomicstrong

viaPoints

- (NSArray<SYWaypoint*>*) viaPoints

readwritenonatomicstrong

evProfile

- (SYEVProfile*) evProfile

readwritenonatomicstrong

evPreferences

- (SYEVPreferences*) evPreferences

readwritenonatomicstrong

aetrProfile

- (SYAETRProfile*) aetrProfile

readwritenonatomicstrong

guidedProfile

- (SYGuidedProfile*) guidedProfile

readwritenonatomicstrong

---

The documentation for this class was generated from the following file:

• SYRouteRequest.h