sdk/com.sygic.sdk.navigation/NavigationManager

NavigationManager

open class NavigationManager : NativeMethodsReceiver, SygicContext.OnContextDestroyListener

Class managing navigation events.

Types

AudioBetterRouteListener

interface AudioBetterRouteListener : NavigationManager.AudioEventListener

Provides audio information about better route.

AudioIncidentListener

interface AudioIncidentListener : NavigationManager.AudioEventListener

Provides audio notification about incident.

AudioInstructionListener

interface AudioInstructionListener : NavigationManager.AudioEventListener

Provides navigation audio instructions.

AudioRailwayCrossingListener

interface AudioRailwayCrossingListener : NavigationManager.AudioEventListener

Provides audio notification about railway crossing .

AudioSharpCurveListener

interface AudioSharpCurveListener : NavigationManager.AudioEventListener

Provides audio notification about sharp curve.

AudioSpeedLimitListener

interface AudioSpeedLimitListener : NavigationManager.AudioEventListener

Provides audio notification about speed limit.

AudioTrafficListener

interface AudioTrafficListener : NavigationManager.AudioEventListener

Provides audio notification about traffic.

AudioTrafficSignListener

interface AudioTrafficSignListener : NavigationManager.AudioEventListener

Provides audio warning about upcoming traffic signs on or in vicinity of projected trajectory

AudioTruckAidListener

interface ~~AudioTruckAidListener~~ : NavigationManager.AudioEventListener

Provides audio warning about upcoming restriction on or in vicinity of projected trajectory

AudioVehicleAidListener

interface AudioVehicleAidListener : NavigationManager.AudioEventListener

Provides audio warning about upcoming restriction on or in vicinity of projected trajectory

AudioVehicleZoneListener

interface AudioVehicleZoneListener : NavigationManager.AudioEventListener

Provides audio warning about current restriction on or in vicinity of projected trajectory

JunctionPassedListener

interface JunctionPassedListener : NavigationManager.RouteEventNotificationListener

Provides callback of passed junction related events.

NotifType

@Retention(value = RetentionPolicy.CLASS)

annotation class NotifType

OnBatteryCapacityListener

interface OnBatteryCapacityListener : NavigationManager.RouteEventNotificationListener

Provides callback of battery capacity changes in kWh from NavigationManager.

OnBetterRouteListener

interface OnBetterRouteListener : NativeMethodsReceiver.NativeListener

Provides callback of data related events from NavigationManager.

OnDirectionListener

interface OnDirectionListener : NavigationManager.RouteEventNotificationListener

Provides callback of direction changed related events from NavigationManager.

OnHighwayExitListener

interface OnHighwayExitListener : NavigationManager.RouteEventNotificationListener

Provides callback of highway exit related events from NavigationManager.

OnIncidentListener

interface OnIncidentListener : NavigationManager.RouteEventNotificationListener

Provides callback of incident related events from NavigationManager.

OnLaneListener

interface OnLaneListener : NavigationManager.RouteEventNotificationListener

Provides callback of lanes related events from NavigationManager.

OnPlaceListener

interface OnPlaceListener : NavigationManager.RouteEventNotificationListener

Provides callback of place on route info related events from NavigationManager.

OnRailwayCrossingListener

interface OnRailwayCrossingListener : NavigationManager.RouteEventNotificationListener

Provides callback of railway related events from NavigationManager.

OnRouteChangedListener

interface OnRouteChangedListener : NativeMethodsReceiver.NativeListener

Provides callback of route changed related events from NavigationManager.

OnRouteProgressListener

interface OnRouteProgressListener

Returns progress info about current navigation route.

OnRouteRecomputeProgressListener

interface OnRouteRecomputeProgressListener : NativeMethodsReceiver.NativeListener

Provides callback of route recompute progress related events from NavigationManager.

OnSharpCurveListener

interface OnSharpCurveListener : NavigationManager.RouteEventNotificationListener

Provides callback of curve info related events from NavigationManager.

OnSignpostListener

interface OnSignpostListener : NavigationManager.RouteEventNotificationListener

Provides callback of navi sign changed related events from NavigationManager.

OnSpeedLimitListener

interface OnSpeedLimitListener : NavigationManager.RouteEventNotificationListener

Provides callback of speed warning related events from NavigationManager.

OnTrafficChangedListener

interface OnTrafficChangedListener : NativeMethodsReceiver.NativeListener

Provides callback of traffic related events from NavigationManager.

OnTrafficSignListener

interface OnTrafficSignListener : NavigationManager.RouteEventNotificationListener

Provides callback of traffic sign feature related events.

OnVehicleAidListener

interface OnVehicleAidListener : NavigationManager.RouteEventNotificationListener

Provides callback of Vehicle Aid feature related events.

OnVehicleZoneListener

interface OnVehicleZoneListener : NavigationManager.RouteEventNotificationListener

Provides callback of Zone feature related events.

OnWaypointOutOfRangeListener

interface OnWaypointOutOfRangeListener : NavigationManager.RouteEventNotificationListener

Provides callback of battery capacity needed to reach finish in kWh when finish is out of range from NavigationManager.

OnWaypointPassListener

interface OnWaypointPassListener : NavigationManager.RouteEventNotificationListener

Provides callback of waypoint related events from NavigationManager.

OnWaypointsListener

interface OnWaypointsListener

Returns all waypoints on current route

RouteRecomputeStatus

annotation class RouteRecomputeStatus

RouteUpdateStatus

@Retention(value = RetentionPolicy.CLASS)

annotation class RouteUpdateStatus

StreetChangedListener

interface StreetChangedListener : NavigationManager.RouteEventNotificationListener

Provides callback of street changed realted events

TruckAidListener

interface ~~TruckAidListener~~ : NavigationManager.RouteEventNotificationListener

Provides callback of Truck Aid feature related events.

Functions

addJunctionPassedListener

open fun addJunctionPassedListener(listener: NavigationManager.JunctionPassedListener)

open fun addJunctionPassedListener(listener: NavigationManager.JunctionPassedListener, @Nullable executor: Executor)

addOnBatteryCapacityListener

open fun addOnBatteryCapacityListener(listener: NavigationManager.OnBatteryCapacityListener)

open fun addOnBatteryCapacityListener(listener: NavigationManager.OnBatteryCapacityListener, @Nullable executor: Executor)

Add a OnBatteryCapacityListener to NavigationManager to subscribe to battery capacity changes.

addOnBetterRouteListener

open fun addOnBetterRouteListener(listener: NavigationManager.OnBetterRouteListener)

open fun addOnBetterRouteListener(listener: NavigationManager.OnBetterRouteListener, @Nullable executor: Executor)

Add a OnBetterRouteListener to NavigationManager to subscribe for better route event(s).

addOnDirectionListener

open fun addOnDirectionListener(listener: NavigationManager.OnDirectionListener)

open fun addOnDirectionListener(listener: NavigationManager.OnDirectionListener, @Nullable executor: Executor)

Add a OnDirectionListener to NavigationManager to subscribe to direction changed event(s).

addOnHighwayExitListener

open fun addOnHighwayExitListener(listener: NavigationManager.OnHighwayExitListener)

open fun addOnHighwayExitListener(listener: NavigationManager.OnHighwayExitListener, @Nullable executor: Executor)

Add a OnHighwayExitListener to NavigationManager to subscribe to highway exit event(s).

addOnIncidentListener

open fun addOnIncidentListener(listener: NavigationManager.OnIncidentListener)

open fun addOnIncidentListener(listener: NavigationManager.OnIncidentListener, @Nullable executor: Executor)

Add a OnIncidentListener to NavigationManager to subscribe to incident event(s).

addOnLaneListener

open fun addOnLaneListener(listener: NavigationManager.OnLaneListener)

open fun addOnLaneListener(listener: NavigationManager.OnLaneListener, @Nullable executor: Executor)

Add a OnLaneListener to NavigationManager to subscribe to lane event(s).

addOnPlaceListener

open fun addOnPlaceListener(listener: NavigationManager.OnPlaceListener)

open fun addOnPlaceListener(listener: NavigationManager.OnPlaceListener, @Nullable executor: Executor)

Add a OnPlaceListener to NavigationManager to subscribe to nearby poi on route data event(s).

addOnRailwayCrossingListener

open fun addOnRailwayCrossingListener(listener: NavigationManager.OnRailwayCrossingListener)

open fun addOnRailwayCrossingListener(listener: NavigationManager.OnRailwayCrossingListener, @Nullable executor: Executor)

Add a OnRailwayCrossingListener to NavigationManager to subscribe to railway event(s).

addOnRouteChangedListener

open fun addOnRouteChangedListener(listener: NavigationManager.OnRouteChangedListener)

open fun addOnRouteChangedListener(listener: NavigationManager.OnRouteChangedListener, @Nullable executor: Executor)

Add a OnRouteChangedListener to NavigationManager to subscribe to route changed event(s).

addOnRouteRecomputeProgressListener

open fun addOnRouteRecomputeProgressListener(listener: NavigationManager.OnRouteRecomputeProgressListener)

open fun addOnRouteRecomputeProgressListener(listener: NavigationManager.OnRouteRecomputeProgressListener, @Nullable executor: Executor)

Add a OnRouteRecomputeProgressListener to NavigationManager to subscribe to route recompute progress event(s).

addOnSharpCurveListener

open fun addOnSharpCurveListener(listener: NavigationManager.OnSharpCurveListener)

open fun addOnSharpCurveListener(listener: NavigationManager.OnSharpCurveListener, @Nullable executor: Executor)

Add a OnSharpCurveListener to NavigationManager to subscribe to sharp curve event(s).

addOnSignpostListener

open fun addOnSignpostListener(listener: NavigationManager.OnSignpostListener)

open fun addOnSignpostListener(listener: NavigationManager.OnSignpostListener, @Nullable executor: Executor)

Add a OnSignpostListener to NavigationManager to subscribe to navi sign event(s).

addOnSpeedLimitListener

open fun addOnSpeedLimitListener(listener: NavigationManager.OnSpeedLimitListener)

open fun addOnSpeedLimitListener(listener: NavigationManager.OnSpeedLimitListener, @Nullable executor: Executor)

Add a OnSpeedLimitListener to NavigationManager to subscribe to speed limit event(s).

addOnTrafficChangedListener

open fun addOnTrafficChangedListener(listener: NavigationManager.OnTrafficChangedListener)

open fun addOnTrafficChangedListener(listener: NavigationManager.OnTrafficChangedListener, @Nullable executor: Executor)

Add a OnTrafficChangedListener to NavigationManager to subscribe to traffic data event(s).

addOnTrafficSignListener

open fun addOnTrafficSignListener(@NonNull listener: NavigationManager.OnTrafficSignListener)

open fun addOnTrafficSignListener(@NonNull listener: NavigationManager.OnTrafficSignListener, @Nullable executor: Executor)

addOnVehicleAidListener

open fun addOnVehicleAidListener(@NonNull listener: NavigationManager.OnVehicleAidListener)

open fun addOnVehicleAidListener(@NonNull listener: NavigationManager.OnVehicleAidListener, @Nullable executor: Executor)

addOnVehicleZoneListener

open fun addOnVehicleZoneListener(@NonNull listener: NavigationManager.OnVehicleZoneListener)

open fun addOnVehicleZoneListener(@NonNull listener: NavigationManager.OnVehicleZoneListener, @Nullable executor: Executor)

addOnWaypointOutOfRangeListener

open fun addOnWaypointOutOfRangeListener(listener: NavigationManager.OnWaypointOutOfRangeListener)

open fun addOnWaypointOutOfRangeListener(listener: NavigationManager.OnWaypointOutOfRangeListener, @Nullable executor: Executor)

Add a OnWaypointOutOfRangeListener to NavigationManager to subscribe to finish out of ev range notification.

addOnWaypointPassListener

open fun addOnWaypointPassListener(listener: NavigationManager.OnWaypointPassListener)

open fun addOnWaypointPassListener(listener: NavigationManager.OnWaypointPassListener, @Nullable executor: Executor)

Add a OnWaypointPassListener to NavigationManager to subscribe to waypoint event(s).

addStreetChangedListener

open fun addStreetChangedListener(listener: NavigationManager.StreetChangedListener)

open fun addStreetChangedListener(listener: NavigationManager.StreetChangedListener, @Nullable executor: Executor)

addTruckAidListener

open fun ~~addTruckAidListener~~(listener: NavigationManager.TruckAidListener)

open fun ~~addTruckAidListener~~(listener: NavigationManager.TruckAidListener, @Nullable executor: Executor)

getCurrentEVProfile

@Nullable

open fun getCurrentEVProfile(): EVProfile

getCurrentRoute

@Nullable

open fun getCurrentRoute(): Route

Returns route which was set calling setRouteForNavigation or was set after automatic recompute

getCurrentRouteWaypoints

open fun getCurrentRouteWaypoints(@NonNull listener: NavigationManager.OnWaypointsListener)

open fun getCurrentRouteWaypoints(@NonNull listener: NavigationManager.OnWaypointsListener, @Nullable executor: Executor)

Returns all waypoints on current route

getCurrentStreetDetail

open fun getCurrentStreetDetail(@NonNull listener: OnStreetDetailListener)

Returns StreetDetail containing information about next junction.

getRouteProgress

open fun getRouteProgress(@NonNull listener: NavigationManager.OnRouteProgressListener)

open fun getRouteProgress(@NonNull listener: NavigationManager.OnRouteProgressListener, @Nullable executor: Executor)

Returns progress info about current navigation route.

getSettings

open fun getSettings(type: Int): RouteEventNotificationsSettings

onContextDestroy

@RestrictTo(value = RestrictTo.Scope.LIBRARY)

open fun onContextDestroy()

removeJunctionPassedListener

open fun removeJunctionPassedListener(listener: NavigationManager.JunctionPassedListener)

removeOnBatteryCapacityListener

open fun removeOnBatteryCapacityListener(listener: NavigationManager.OnBatteryCapacityListener)

Remove a OnBatteryCapacityListener previously added to NavigationManager.

removeOnBetterRouteListener

open fun removeOnBetterRouteListener(listener: NavigationManager.OnBetterRouteListener)

Remove a OnBetterRouteListener previously added to NavigationManager.

removeOnDirectionListener

open fun removeOnDirectionListener(listener: NavigationManager.OnDirectionListener)

Remove a OnDirectionListener previously added to NavigationManager.

removeOnHighwayExitListener

open fun removeOnHighwayExitListener(listener: NavigationManager.OnHighwayExitListener)

Remove a OnHighwayExitListener previously added to NavigationManager.

removeOnIncidentListener

open fun removeOnIncidentListener(listener: NavigationManager.OnIncidentListener)

Remove a OnIncidentListener previously added to NavigationManager.

removeOnLaneListener

open fun removeOnLaneListener(listener: NavigationManager.OnLaneListener)

Remove a OnLaneListener previously added to NavigationManager.

removeOnPlaceListener

open fun removeOnPlaceListener(listener: NavigationManager.OnPlaceListener)

Remove a OnPlaceListener previously added to NavigationManager.

removeOnRailwayCrossingListener

open fun removeOnRailwayCrossingListener(listener: NavigationManager.OnRailwayCrossingListener)

Remove a OnRailwayCrossingListener previously added to NavigationManager.

removeOnRouteChangedListener

open fun removeOnRouteChangedListener(listener: NavigationManager.OnRouteChangedListener)

Remove a OnRouteChangedListener previously added to NavigationManager.

removeOnRouteRecomputeProgressListener

open fun removeOnRouteRecomputeProgressListener(listener: NavigationManager.OnRouteRecomputeProgressListener)

Remove a OnRouteRecomputeProgressListener previously added to NavigationManager.

removeOnSharpCurveListener

open fun removeOnSharpCurveListener(listener: NavigationManager.OnSharpCurveListener)

Remove a OnSharpCurveListener previously added to NavigationManager.

removeOnSignpostListener

open fun removeOnSignpostListener(listener: NavigationManager.OnSignpostListener)

Remove a OnSignpostListener previously added to NavigationManager.

removeOnSpeedLimitListener

open fun removeOnSpeedLimitListener(listener: NavigationManager.OnSpeedLimitListener)

Remove a OnSpeedLimitListener previously added to NavigationManager.

removeOnTrafficChangedListener

open fun removeOnTrafficChangedListener(listener: NavigationManager.OnTrafficChangedListener)

Remove a OnTrafficChangedListener previously added to NavigationManager.

removeOnTrafficSignListener

open fun removeOnTrafficSignListener(@NonNull listener: NavigationManager.OnTrafficSignListener)

removeOnVehicleAidListener

open fun removeOnVehicleAidListener(@NonNull listener: NavigationManager.OnVehicleAidListener)

removeOnVehicleZoneListener

open fun removeOnVehicleZoneListener(@NonNull listener: NavigationManager.OnVehicleZoneListener)

removeOnWaypointOutOfRangeListener

open fun removeOnWaypointOutOfRangeListener(listener: NavigationManager.OnWaypointOutOfRangeListener)

Remove a OnWaypointOutOfRangeListener previously added to NavigationManager.

removeOnWaypointPassListener

open fun removeOnWaypointPassListener(listener: NavigationManager.OnWaypointPassListener)

Remove a OnWaypointPassListener previously added to NavigationManager.

removeStreetChangedListener

open fun removeStreetChangedListener(listener: NavigationManager.StreetChangedListener)

removeTruckAidListener

open fun ~~removeTruckAidListener~~(listener: NavigationManager.TruckAidListener)

replayLastAudioInstruction

open fun replayLastAudioInstruction()

Replay last audio instruction.

setAudioBetterRouteListener

open fun setAudioBetterRouteListener(listener: NavigationManager.AudioBetterRouteListener)

setAudioIncidentListener

open fun setAudioIncidentListener(listener: NavigationManager.AudioIncidentListener)

setAudioInstructionListener

open fun setAudioInstructionListener(listener: NavigationManager.AudioInstructionListener)

setAudioRailwayCrossingListener

open fun setAudioRailwayCrossingListener(listener: NavigationManager.AudioRailwayCrossingListener)

setAudioSharpCurveListener

open fun setAudioSharpCurveListener(listener: NavigationManager.AudioSharpCurveListener)

setAudioSpeedLimitListener

open fun setAudioSpeedLimitListener(listener: NavigationManager.AudioSpeedLimitListener)

setAudioTrafficListener

open fun setAudioTrafficListener(listener: NavigationManager.AudioTrafficListener)

setAudioTrafficSignListener

open fun setAudioTrafficSignListener(@Nullable listener: NavigationManager.AudioTrafficSignListener)

setAudioVehicleAidListener

open fun setAudioVehicleAidListener(@Nullable listener: NavigationManager.AudioVehicleAidListener)

setAudioVehicleZoneListener

open fun setAudioVehicleZoneListener(@Nullable listener: NavigationManager.AudioVehicleZoneListener)

setBatteryStatusUpdateEnabled

open fun setBatteryStatusUpdateEnabled(enabled: Boolean)

Enable or disable receiving updates to battery capacity changes.

setCurrentEVProfile

open fun setCurrentEVProfile(@Nullable profile: EVProfile)

Sets EV profile to be used by navigation.

setRouteForNavigation

open fun setRouteForNavigation(route: Route): Boolean

Sets the route for navigation.

stopNavigation

open fun stopNavigation()

Stops the current navigation.

Properties

currentRouteWaypoints

@get:NonNull

open val currentRouteWaypoints: List<Waypoint>

routeProgress

@get:NonNull

open val routeProgress: RouteProgress