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...
 

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...
 
SYRouteEventNotoficationsSettingssettings
 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. More...
 
SYEVProfilecurrentEVProfile
 ev profile for current navigation. More...
 
NavigationDelegate sdkNaviDelegate [implementation]
 

Detailed Description

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

Method Documentation

◆ __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__

◆ getRouteProgress()

- (nullable SYRouteProgress*) getRouteProgress

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

◆ isNavigating()

- (BOOL) isNavigating

Return yes, if you are currently in navigation mode.

◆ replayLastInstructionAudioFeedback()

- (void) replayLastInstructionAudioFeedback

Replays last instruction audio feedback during navigation.

◆ sharedNavigation()

+ (nonnull SYNavigationManager*) sharedNavigation

Returns SYNavigationManager singleton instance.

◆ 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.

Property Documentation

◆ audioFeedbackDelegate

- (id<SYNavigationAudioFeedbackDelegate>) audioFeedbackDelegate
readwritenonatomicweak

Delegate to handle audio feedback.

◆ 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.

◆ currentEVProfile

- (SYEVProfile*) currentEVProfile
readwritenonatomicassign

ev profile for current navigation.

◆ sdkNaviDelegate

- (NavigationDelegate) sdkNaviDelegate
readwritenonatomicassignimplementation

◆ settings

- (SYRouteEventNotoficationsSettings*) settings
readnonatomicassign

Route events notifications settings.

◆ waypoints

- (NSArray<SYWaypoint*>*) waypoints
readnonatomicassign

The time interval returned includes delays due to traffic etc.


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