SYNavigationManager Class Reference

SYNavigationManager is a class that provides guidance advice and information along a route. More...

#import <SYNavigationManager.h>

Inheritance diagram for SYNavigationManager:
Collaboration diagram for SYNavigationManager:

Instance Methods

((unavailable("Use +[SYNavigation sharedNavigation] instead.") - __attribute__
 SYNavigation is singleton, use [SYNavigation sharedNavigation] to access singleton instance. More...
 
(void) - startNavigationWithRoute:
 Starts a turn-by-turn navigation session using the specified route. More...
 
(void) - stopNavigation
 Stops the current navigation started via startNavigationWithRoute. More...
 
(BOOL) - isNavigating
 Return yes, if you are currently in navigation mode. More...
 
(nullable SYRouteProgress *) - getRouteProgress
 Get current navigation route info. Returns nil if SYNavigationManager is not navigating. More...
 
(void) - replayLastInstructionAudioFeedback
 Replays last instruction audio feedback during navigation. More...
 
(void) - getCurrentStreetDetailWithCompletion:
 This method will provide additional information about currently passed route. More...
 

Class Methods

(nonnull SYNavigationManager *) + sharedNavigation
 Returns SYNavigationManager singleton instance. More...
 
((unavailable("Use +[SYNavigation sharedNavigation] instead.") + __attribute__
 

Properties

id< SYNavigationAudioFeedbackDelegateaudioFeedbackDelegate
 Delegate to handle audio feedback. More...
 
NSArray< SYWaypoint * > * waypoints
 The time interval returned includes delays due to traffic etc. More...
 
SYRouteEventNotificationsSettingssettings
 Route events notifications settings. More...
 
BOOL backgroundNavigationEnabled
 Controls whether navigation is paused when the application is sent to the background. The current [SYPositioning dataSource] must support background position updates in order to navigate in the background. More...
 
BOOL batteryStatusUpdateEnabled
 Enables automatic profile updating with delegate callback didUpdateBatteryCapacity. Note that didUpdateBatteryCapacity is called only if currentEVProfile is not nil. More...
 
SYEVProfilecurrentEVProfile
 Electric vehicle profile for current navigation. Also used as a filter for EV charging stations in places on route notification (SYNavigationDelegate navigation:didUpdatePlace:). If the value is nil, SYNavigationDelegate is called as follows: navigation:didUpdatePlace: will deliver all available EV stations, navigation:didFindWaypointOutOfRange:withCapacity: will not be called while currentEVProfile is nil, navigation:didUpdateBatteryCapacity: will not be called while currentEVProfile is nil. Default value is nil. More...
 

Detailed Description

SYNavigationManager is a class that provides guidance advice and information along a route.

Method Documentation

◆ sharedNavigation

+ (nonnull SYNavigationManager*) sharedNavigation

Returns SYNavigationManager singleton instance.

◆ __attribute__ [1/2]

- ((unavailable("Use +[SYNavigation sharedNavigation] instead.") __attribute__

SYNavigation is singleton, use [SYNavigation sharedNavigation] to access singleton instance.

◆ __attribute__ [2/2]

+ ((unavailable("Use +[SYNavigation sharedNavigation] instead.") __attribute__

◆ startNavigationWithRoute:

- (void) startNavigationWithRoute: (nullable SYRoute *)  route

Starts a turn-by-turn navigation session using the specified route.

◆ stopNavigation

- (void) stopNavigation

Stops the current navigation started via startNavigationWithRoute.

◆ isNavigating

- (BOOL) isNavigating

Return yes, if you are currently in navigation mode.

◆ getRouteProgress

- (nullable SYRouteProgress*) getRouteProgress

Get current navigation route info. Returns nil if SYNavigationManager is not navigating.

◆ replayLastInstructionAudioFeedback

- (void) replayLastInstructionAudioFeedback

Replays last instruction audio feedback during navigation.

◆ getCurrentStreetDetailWithCompletion:

- (void) getCurrentStreetDetailWithCompletion: (nonnull SYStreetDetailCompletionBlock)  completion

This method will provide additional information about currently passed route.

Parameters
completioncallback to receive requested additional information.

Property Documentation

◆ audioFeedbackDelegate

- (id<SYNavigationAudioFeedbackDelegate>) audioFeedbackDelegate
readwritenonatomicweak

Delegate to handle audio feedback.

◆ waypoints

- (NSArray<SYWaypoint*>*) waypoints
readnonatomicassign

The time interval returned includes delays due to traffic etc.

◆ settings

- (SYRouteEventNotificationsSettings*) settings
readnonatomicassign

Route events notifications settings.

◆ backgroundNavigationEnabled

- (BOOL) backgroundNavigationEnabled
readwritenonatomicassign

Controls whether navigation is paused when the application is sent to the background. The current [SYPositioning dataSource] must support background position updates in order to navigate in the background.

◆ batteryStatusUpdateEnabled

- (BOOL) batteryStatusUpdateEnabled
readwritenonatomicassign

Enables automatic profile updating with delegate callback didUpdateBatteryCapacity. Note that didUpdateBatteryCapacity is called only if currentEVProfile is not nil.

◆ currentEVProfile

- (SYEVProfile*) currentEVProfile
readwritenonatomicassign

Electric vehicle profile for current navigation. Also used as a filter for EV charging stations in places on route notification (SYNavigationDelegate navigation:didUpdatePlace:). If the value is nil, SYNavigationDelegate is called as follows: navigation:didUpdatePlace: will deliver all available EV stations, navigation:didFindWaypointOutOfRange:withCapacity: will not be called while currentEVProfile is nil, navigation:didUpdateBatteryCapacity: will not be called while currentEVProfile is nil. Default value is nil.


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