SYRouteExplorer Class Reference

#import <SYRouteExplorer.h>

Inheritance diagram for SYRouteExplorer:
Collaboration diagram for SYRouteExplorer:

Class Methods

(nonnull SYTask *) + exploreIncidentsOnRoute:incidentsFilter:withCompletion:
 Load all incidents allong the route. More...
 
(nonnull SYTask *) + explorePlacesOnRoute:placesFilter:withCompletion:
 Explore all places along the route. More...
 
(nonnull SYTask *) + exploreTrafficOnRoute:withCompletion:
 Explore traffic events along route. Function require network connection. More...
 
(nonnull SYTask *) + exploreChargingStationsOnRoute:withProfile:withCompletion:
 Explore charging stations along the route compatible with ev profile. More...
 

Method Documentation

◆ exploreIncidentsOnRoute:incidentsFilter:withCompletion:

+ (nonnull SYTask*) exploreIncidentsOnRoute: (nullable SYRoute *)  route
incidentsFilter: (nullable NSArray< NSString * > *)  filter
withCompletion: (nonnull void(^)(NSArray< SYIncidentInfo * > *_Nullable info, NSInteger progress, NSError *_Nullable error))  completion 

Load all incidents allong the route.

Parameters
routeRoute to explore
filterFilter SYIncidentType. Leave empty or nil for any categories
completionCalled multiple times with progress of exploration and data already anlyzed. Last call is with progress 100.

◆ explorePlacesOnRoute:placesFilter:withCompletion:

+ (nonnull SYTask*) explorePlacesOnRoute: (nonnull SYRoute *)  route
placesFilter: (nullable NSArray< NSString * > *)  filter
withCompletion: (nonnull void(^)(NSArray< SYPlaceInfo * > *_Nullable places, NSInteger progress, NSError *_Nullable error))  completion 

Explore all places along the route.

Parameters
routeRoute to explore
filterFilter SYPlaceCategory. Leave empty or nil for any categories
completionCalled multiple times with progress of exploration and data already anlyzed. Last call is with progress 100.

◆ exploreTrafficOnRoute:withCompletion:

+ (nonnull SYTask*) exploreTrafficOnRoute: (nonnull SYRoute *)  route
withCompletion: (nonnull void(^)(SYTrafficInfo *_Nullable traffic, NSError *_Nullable error))  completion 

Explore traffic events along route. Function require network connection.

Parameters
routeRoute to explore
completionwith SYTrafficInfo for requested route

◆ exploreChargingStationsOnRoute:withProfile:withCompletion:

+ (nonnull SYTask*) exploreChargingStationsOnRoute: (nonnull SYRoute *)  route
withProfile: (nonnull SYEVProfile *)  profile
withCompletion: (nonnull void(^)(NSArray< SYChargingStationInfo * > *_Nullable stations, NSInteger progress, NSError *_Nullable error))  completion 

Explore charging stations along the route compatible with ev profile.

Parameters
routeRoute to explore
profileElectric vehicle profile
completionCalled multiple times with progress of exploration and data already analyzed. Last call is with progress 100.

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