NavigationListener

Navigation listener interface.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

NavigationListener's companion object.

Properties

Link copied to clipboard

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Link copied to clipboard

This will be used by the engine when a voice prompt needs to be played to check if it is allowed to send a NavigationSound notification or not. If this is false then the engine will not send the onNavigationSound notification but it will recheck if possible to play it periodically until it is allowed or it is no more valid.

Functions

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

Link copied to clipboard
open fun onBetterRouteDetected(route: Route, travelTime: Int, delay: Int, timeGain: Int)

Better route was detected. The previous better route ( if exist ) must be considered automatically invalidated This notification is sent when a route is calculated with RoutePreferences.avoidTraffic = true and the engine detects a better route.

Link copied to clipboard

Previously detected better route became invalid. This notification is sent when current position is no more on the previous calculated better route

Link copied to clipboard

Better route rejected with given error code ( debug purposes )

Link copied to clipboard
open fun onDestinationReached(landmark: Landmark)

Notification received when the destination have been reached. This is the moment when the navigation request finished with success.

Link copied to clipboard
open fun onNavigationError(error: ErrorCode)

Signal that the navigation request finished with error.

Link copied to clipboard

Notification called when the navigation instruction is updated. This method is called periodically, usually at 1 second, to update the navigation information for the UI.

Link copied to clipboard
open fun onNavigationSound(sound: ISound)

This notification is provided by the navigation/simulation when a sound needs to be played.

Link copied to clipboard

Navigation started notification This method is called when first valid position for navigation arrives

Link copied to clipboard

Notifies new value of ENavigationStatus.

Link copied to clipboard
open fun onRouteUpdated(route: Route)

Notification received when route was updated.

Link copied to clipboard
open fun onWaypointReached(landmark: Landmark)

Notification received when a way point on the route has been reached. This notification is not sent when the destination of the route has been reached. That is notified through onDestinationReached notification.

Link copied to clipboard
fun release()

Releases the native referenced value of this object if: