<SYNavigationDelegate> Protocol Reference

Receives event callbacks containing information about the current navigation session. More...

#import <SYNavigationManager.h>

Inheritance diagram for <SYNavigationDelegate>:
Collaboration diagram for <SYNavigationDelegate>:

Instance Methods

(void) - navigation:didUpdateSpeedLimit:
 Called when a speed limit warning has changed. More...
 
(void) - navigation:didUpdateDirection:
 Called when current instruction has changed. More...
 
(void) - navigation:didUpdateSignpost:
 Called when current singpostinfo is changed. More...
 
(void) - navigation:didUpdateIncident:
 Called when current incident has changed. More...
 
(void) - navigation:didUpdateRailwayCrossing:
 Called when current route railway crossing has changed. More...
 
(void) - navigation:didUpdateSharpCurve:
 Called when danger turn is ahead on current route. More...
 
(void) - navigation:didPassWaypointWithIndex:
 Called when turn-by-turn navigation waipoint is passed. More...
 
(void) - navigationManagerDidReachFinish:
 Called when turn-by-turn navigation destination is reached. More...
 
(void) - navigation:didFindBetterRoute:
 Called when better route is found. More...
 
(void) - navigation:didUpdateHighwayExit:
 Called when hihgway exit info has changed. Event does not fire when route is calculated. More...
 
(void) - navigation:didUpdateRoute:withStatus:
 Called when current navigation route is changed or removed. More...
 
(void) - navigation:didUpdateRecomputeProgress:withStatus:
 Called when current navigation route starts recomputing. More...
 
(void) - navigation:didUpdatePlace:
 Called when places on current navigation route have changed. More...
 
(void) - navigation:didUpdateLane:
 Called when lane information on current navigation route has changed. More...
 
(void) - navigation:didUpdateTraffic:
 Called when traffic on the current navigation route is changed. This method will only be called when SYNavigationManager is navigating a route using a transport mode of SYTransportModeCar and SYTraffic.trafficServiceEnabled. More...
 
(void) - navigation:didUpdateBatteryCapacity:
 Called when battery capacity has changed. Precondition: SYNavigationManager batteryStatusUpdateEnabled is true, and currentEVProfile is not nil. More...
 
(void) - navigation:didFindWaypointOutOfRange:withCapacity:
 Called when charging waypoint on route is out of range from your position. Precondition: SYNavigationManager currentEVProfile is not nil. More...
 
(void) - navigation:didStreetChange:
 Called when new street is reached. More...
 
(void) - navigation:didPassJunction:
 Called when navigation has passed junction. More...
 
(void) - navigation:didNotifyTruckAid:
 Called when restrictions are discovered on predicted trajectory or close to it. More...
 

Detailed Description

Receives event callbacks containing information about the current navigation session.

Method Documentation

◆ navigation:didUpdateSpeedLimit:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateSpeedLimit: (nullable SYSpeedLimitInfo *)  limit 
optional

Called when a speed limit warning has changed.

Parameters
limitCurrent speed limit.

◆ navigation:didUpdateDirection:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateDirection: (nullable SYDirectionInfo *)  instruction 
optional

Called when current instruction has changed.

Parameters
instructionCurrent instruction.

◆ navigation:didUpdateSignpost:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateSignpost: (nullable NSArray< SYSignpostInfo * > *)  signpostInfo 
optional

Called when current singpostinfo is changed.

Parameters
signpostInfoArray of signposts.

◆ navigation:didUpdateIncident:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateIncident: (nullable SYIncidentInfo *)  incidentInfo 
optional

Called when current incident has changed.

Parameters
incidentInfoCurrent incident. Nil if no incident is available.

◆ navigation:didUpdateRailwayCrossing:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateRailwayCrossing: (nullable SYRailwayCrossingInfo *)  railwayInfo 
optional

Called when current route railway crossing has changed.

Parameters
railwayInfoCurrent railway crossing. Nil if no crossing is ahead on route.

◆ navigation:didUpdateSharpCurve:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateSharpCurve: (nullable SYSharpCurveInfo *)  sharpCurve 
optional

Called when danger turn is ahead on current route.

Parameters
sharpCurveCurve info. Nil if no data is available.

◆ navigation:didPassWaypointWithIndex:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didPassWaypointWithIndex: (NSUInteger)  index 
optional

Called when turn-by-turn navigation waipoint is passed.

Parameters
indexWaypoint index, as passed in viapoints in [SYRouting computeRoute:from:to:via]

◆ navigationManagerDidReachFinish:

- (void) navigationManagerDidReachFinish: (nonnull SYNavigationObserver *)  observer
optional

Called when turn-by-turn navigation destination is reached.

◆ navigation:didFindBetterRoute:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didFindBetterRoute: (nullable SYBetterRoute *)  alterRoute 
optional

Called when better route is found.

Parameters
alterRouteBetter Route info. Nil if no data is available.

◆ navigation:didUpdateHighwayExit:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateHighwayExit: (nullable NSArray< SYHighwayExitInfo * > *)  highwayExit 
optional

Called when hihgway exit info has changed. Event does not fire when route is calculated.

Parameters
highwayExitHighway exit info. Nil if no data is available.

◆ navigation:didUpdateRoute:withStatus:

- (void) navigation: (nonnull SYNavigationObserver *)  navigation
didUpdateRoute: (nullable SYRoute *)  route
withStatus: (SYRouteUpdateStatus)  status 
optional

Called when current navigation route is changed or removed.

Parameters
routeUpdated route. Nil if navigation has been stopped.
statusReason in case route is null.

◆ navigation:didUpdateRecomputeProgress:withStatus:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateRecomputeProgress: (NSUInteger)  progress
withStatus: (SYNavigationRecomputeStatus)  status 
optional

Called when current navigation route starts recomputing.

Parameters
progressfrom 0 to 100
statusof recmoputing

◆ navigation:didUpdatePlace:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdatePlace: (nullable NSArray< SYPlaceInfo * > *)  places 
optional

Called when places on current navigation route have changed.

Parameters
placesAll reachable places along the route.

◆ navigation:didUpdateLane:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateLane: (nullable SYLaneInfo *)  lane 
optional

Called when lane information on current navigation route has changed.

◆ navigation:didUpdateTraffic:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateTraffic: (nullable SYTrafficInfo *)  trafficInfo 
optional

Called when traffic on the current navigation route is changed. This method will only be called when SYNavigationManager is navigating a route using a transport mode of SYTransportModeCar and SYTraffic.trafficServiceEnabled.

Parameters
trafficInfoTraffic info, it is nil if no data is available.

◆ navigation:didUpdateBatteryCapacity:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didUpdateBatteryCapacity: (float)  capacity 
optional

Called when battery capacity has changed. Precondition: SYNavigationManager batteryStatusUpdateEnabled is true, and currentEVProfile is not nil.

Parameters
capacityremaining capacity in kWh

◆ navigation:didFindWaypointOutOfRange:withCapacity:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didFindWaypointOutOfRange: (NSInteger)  index
withCapacity: (float)  capacity 
optional

Called when charging waypoint on route is out of range from your position. Precondition: SYNavigationManager currentEVProfile is not nil.

Parameters
indexof charging waypoint from SYRoute::waypoints array which is out of range, if -1 then it is route finish
capacityremaining capacity in kWh

◆ navigation:didStreetChange:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didStreetChange: (nonnull SYStreetInfo *)  info 
optional

Called when new street is reached.

Parameters
infoInformation about new street.

◆ navigation:didPassJunction:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didPassJunction: (SYStreetAttribute)  type 
optional

Called when navigation has passed junction.

Parameters
typeType of passed junction.

◆ navigation:didNotifyTruckAid:

- (void) navigation: (nonnull SYNavigationObserver *)  observer
didNotifyTruckAid: (nullable NSArray< SYTruckAidInfo * > *)  info 
optional

Called when restrictions are discovered on predicted trajectory or close to it.

Parameters
infoInformation about upcoming restrictions.

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