Package com.here.sdk.navigation

Class Navigator

java.lang.Object
com.here.NativeBase
com.here.sdk.navigation.Navigator
All Implemented Interfaces:
LocationListener, NavigatorInterface
public final class Navigator extends NativeBase implements NavigatorInterface

This class provides the basic navigation functionality. It provides notifications about current map-matched location updates (see NavigableLocation). And, if a route has been set, about the route progress (see RouteProgress), route deviations (see RouteDeviation) and maneuver notifications (see EventTextListener).

All transport modes are supported for turn-by-turn navigation, except for public transit. Public transit routes may lead to unsafe and unexpected results.

Navigation support for bus routes can be sometimes a bit limited and bus lane assistance and turn-by-turn bus instructions may not be as appropriate as expected.

The TransportMode is determined from the provided Route instance, but the actual SectionTransportMode can vary along a route, for example, when a ferry must be taken. When no route is set, the NavigableLocation assumes a drive scenario.

This class continuously reacts to new locations provided from a location source and acts as a LocationListener. The accuracy of the positioning increases with the update frequency. At least one update per second should be provided. More information can be found at LocationAccuracy.NAVIGATION.

Note: Even without provided locations, for example, while driving through a tunnel, this class can interpolate missing location events and still send NavigableLocation, RouteProgress and maneuver notifications.

  • Constructor Details

  • Method Details

    • getAvailableLanguagesForManeuverNotifications

      @NonNull public static List<LanguageCode> getAvailableLanguagesForManeuverNotifications()

      Returns the list of languages for maneuver notification currently available in the SDK.

      Returns:

      the list of languages for maneuver notification currently available in the SDK.

    • getManeuver

      @Nullable public Maneuver getManeuver(int index)

      Returns maneuver at the given index.

      Specified by:
      getManeuver in interface NavigatorInterface
      Parameters:
      index -

      The index of maneuver requested.

      Returns:

      The maneuver if it exists or otherwise null.

    • getManeuverNotificationTimingOptions

      @NonNull public ManeuverNotificationTimingOptions getManeuverNotificationTimingOptions(@NonNull TransportMode transportMode, @NonNull TimingProfile timingProfile)

      Returns maneuver notification timing options with default values given the combination of transport mode and timing profile. The return value can be used as the base for configuring maneuver notification timings. Configure the relevant attributes of this object according to your preferences, and then set it by calling setManeuverNotificationTimingOptions function for the same combination of transport mode and timing profile.

      Specified by:
      getManeuverNotificationTimingOptions in interface NavigatorInterface
      Parameters:
      transportMode -

      The transport mode of the timing options.

      timingProfile -

      The timing profile of the timing options.

      Returns:

      The timing options with default values.

    • setManeuverNotificationTimingOptions

      public boolean setManeuverNotificationTimingOptions(@NonNull TransportMode transportMode, @NonNull TimingProfile timingProfile, @NonNull ManeuverNotificationTimingOptions options)

      Set timing option values for the combination of transport mode and timing profile.

      Specified by:
      setManeuverNotificationTimingOptions in interface NavigatorInterface
      Parameters:
      transportMode -

      The transport mode of the timing options.

      timingProfile -

      The timing profile of the timing options.

      options -

      The timing options.

      Returns:

      True if set successfully, false when options has invalid value, see ManeuverNotificationTimingOptions for more details about options.

    • getWarningNotificationDistances

      @NonNull public WarningNotificationDistances getWarningNotificationDistances(@NonNull WarningType warningType)

      Returns the warning notification distances for the requested warning type. The return value can be used as the base for configuring warning notification distances. Configure the relevant attributes of this object according to your preferences, and then set it by calling setWarningNotificationDistances function with the same warning type and the modified warning notification distances object.

      Specified by:
      getWarningNotificationDistances in interface NavigatorInterface
      Parameters:
      warningType -

      The warning type for which the notification distances will be returned.

      Returns:

      The notification distances for the given warning type.

    • setWarningNotificationDistances

      public boolean setWarningNotificationDistances(@NonNull WarningType warningType, @NonNull WarningNotificationDistances warningNotificationDistances)

      Set the warning notification distances for the specified warning types. Note: The warning notification distances are set for most warners. This method can't be used to set the warning notification distance for the School Zone warning type because it is applicable regardless of the timing profile. Use NavigatorInterface.school_zone_warning_options instead. Attempting to set the warning notification distances for the school zone warner using the NavigatorInterface.set_warning_notification_distances method will fail and return false. Always use SchoolZoneWarningOptions.warning_distance_in_meters to set the warning notification distance for the school zone warner regardless of the TimingProfile. If NavigatorInterface.set_warning_notification_distances could be used, this would allow for different distances to be set for each timing profile, which is undesirable. Attempting to set the warning notification distances for the traffic merge warner using the NavigatorInterface.set_warning_notification_distances method will fail and return false. Always use TrafficMergeWarningOptions.warning_distance_in_meters to set the warning notification distance for the traffic merge warner regardless of the TimingProfile. Using the NavigatorInterface.set_warning_notification_distances method will fail and return false to avoid seting different distances on each timing profile since the traffic merge warning is only applicable on highways.

      Specified by:
      setWarningNotificationDistances in interface NavigatorInterface
      Parameters:
      warningType -

      The warning type for which the warning notification distances will be set.

      warningNotificationDistances -

      The warning notification distances to be set for the specified warning types.

      Returns:

      True if set successfully, false when the warning_type is [WarningType.SCHOOL_ZONE] or the options have invalid values, see WarningNotificationDistances for more details about warning notification distances.

    • repeatLastManeuverNotification

      public void repeatLastManeuverNotification()

      Call of this function is used to trigger the navigator to repeat the last maneuver notification based on the current position.

      Specified by:
      repeatLastManeuverNotification in interface NavigatorInterface

    • calculateRemainingDistanceInMeters

      @Nullable public Integer calculateRemainingDistanceInMeters(@NonNull GeoCoordinates coordinates)

      This method calculates the distance between the current position and given coordinates. The coordinates must be on the polyline.

      Specified by:
      calculateRemainingDistanceInMeters in interface NavigatorInterface
      Parameters:
      coordinates -

      The geographic coordinates of the location.

      Returns:

      distance in meters or null if given coordinates are not on route or given coordinates were already traversed.

    • setCustomOption

      public void setCustomOption(@NonNull String key, @NonNull String value)

      This method sets custom options that controls navigator behavior. Unsupported options are silently ignored. Undocumented options can change their meaning without going through deprecation process.

      Specified by:
      setCustomOption in interface NavigatorInterface
      Parameters:
      key -

      Option name

      value -

      New option value

    • onLocationUpdated

      public void onLocationUpdated(@NonNull Location location)

      Called each time a new location is available. In a navigation context while using the Navigator or VisualNavigator, it's required to set the Location.time parameter for each Location object so that the HERE SDK can map-match the locations properly. If the Location.time parameter is missing, the location will be ignored. For navigation, it is also recommended to provide the bearing and speed parameters for each Location object. Invoked on the main thread.

      Specified by:
      onLocationUpdated in interface LocationListener
      Parameters:
      location -

      Current location.

    • getRoute

      @Nullable public Route getRoute()

      Gets the route that is being navigated.

      Gets and sets the route that is being navigated. If not set, only the current location information will be provided through NavigableLocationListener. If set, both route progress (RouteProgressListener) and route deviation (RouteDeviationListener) will receive notifications on updates. A route may fail to be set if it is generated by an incompatible engine, in which case the operation has no effect.

      Specified by:
      getRoute in interface NavigatorInterface
      Returns:

      The route to navigate.

    • setRoute

      public void setRoute(@Nullable Route value)

      Sets the route to navigate.

      Gets and sets the route that is being navigated. If not set, only the current location information will be provided through NavigableLocationListener. If set, both route progress (RouteProgressListener) and route deviation (RouteDeviationListener) will receive notifications on updates. A route may fail to be set if it is generated by an incompatible engine, in which case the operation has no effect.

      Specified by:
      setRoute in interface NavigatorInterface
      Parameters:
      value -

      The route to navigate.

    • getTrackingTransportProfile

      @Nullable public TransportProfile getTrackingTransportProfile()

      Gets the transport profile for the Navigator, when no route is present.

      Properly setting the transport profile optimizes the navigation experience, and improves resource consumption. For example, a TransportProfile can be defined with a VehicleProfile. A vehicle profile can have several parameters such as VehicleType to set the source of information describing the vehicle. The default is a VehicleType.CAR profile.

      Currently used members of TransportProfile

      • VehicleType: Sets the transport mode.
      • From vehicleProfile:
        • grossWeightInKilograms: Required for truck related speed information.
        • heightInCentimeters: Required for truck related speed information.
        • widthInCentimeters: Additional truck definition for more specific truck speed information.
        • lengthInCentimeters: Additional truck definition for more specific truck speed information.
      Specified by:
      getTrackingTransportProfile in interface NavigatorInterface
      Returns:

      Defines the transport profile for the Navigator, when no route is present.

    • setTrackingTransportProfile

      public void setTrackingTransportProfile(@Nullable TransportProfile value)

      Sets the transport profile for the Navigator, when no route is present.

      Properly setting the transport profile optimizes the navigation experience, and improves resource consumption. For example, a TransportProfile can be defined with a VehicleProfile. A vehicle profile can have several parameters such as VehicleType to set the source of information describing the vehicle. The default is a VehicleType.CAR profile.

      Currently used members of TransportProfile

      • VehicleType: Sets the transport mode.
      • From vehicleProfile:
        • grossWeightInKilograms: Required for truck related speed information.
        • heightInCentimeters: Required for truck related speed information.
        • widthInCentimeters: Additional truck definition for more specific truck speed information.
        • lengthInCentimeters: Additional truck definition for more specific truck speed information.
      Specified by:
      setTrackingTransportProfile in interface NavigatorInterface
      Parameters:
      value -

      Defines the transport profile for the Navigator, when no route is present.

    • getNavigableLocationListener

      @Nullable public NavigableLocationListener getNavigableLocationListener()

      Gets the listener that notifies current location updates.

      It returns null when no listener is set by an user.

      Specified by:
      getNavigableLocationListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about the current location.

    • setNavigableLocationListener

      public void setNavigableLocationListener(@Nullable NavigableLocationListener value)

      Sets the listener that notifies current location updates.

      It returns null when no listener is set by an user.

      Specified by:
      setNavigableLocationListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about the current location.

    • getRouteProgressListener

      @Nullable public RouteProgressListener getRouteProgressListener()

      Gets the listener that notifies when a route progress change occurs.

      Route progress notifications only occurs if the route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getRouteProgressListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about navigation route progress.

    • setRouteProgressListener

      public void setRouteProgressListener(@Nullable RouteProgressListener value)

      Sets the listener that notifies when a route progress change occurs.

      Route progress notifications only occurs if the route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setRouteProgressListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about navigation route progress.

    • getRouteDeviationListener

      @Nullable public RouteDeviationListener getRouteDeviationListener()

      Gets the listener that notifies when deviation from the route is observed.

      Route deviation notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getRouteDeviationListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about deviations from the route if any occurs.

    • setRouteDeviationListener

      public void setRouteDeviationListener(@Nullable RouteDeviationListener value)

      Sets the listener that notifies when deviation from the route is observed.

      Route deviation notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setRouteDeviationListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about deviations from the route if any occurs.

    • getEventTextListener

      @Nullable public EventTextListener getEventTextListener()

      Gets the listener that notifies when a text notification is available.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Note: In order to receive the text notification emitted for the traffic merge warner, when TrafficMergeWarningOptions.enable_text_notification has been enabled, the sdk.navigation.EventTextListener must be enabled as well.

      Specified by:
      getEventTextListener in interface NavigatorInterface
      Returns:

      Object to receive text notifications when they are available.

    • setEventTextListener

      public void setEventTextListener(@Nullable EventTextListener value)

      Sets the listener that notifies when a text notification is available.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Note: In order to receive the text notification emitted for the traffic merge warner, when TrafficMergeWarningOptions.enable_text_notification has been enabled, the sdk.navigation.EventTextListener must be enabled as well.

      Specified by:
      setEventTextListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive text notifications when they are available.

    • getMilestoneStatusListener

      @Nullable public MilestoneStatusListener getMilestoneStatusListener()

      Gets the listener that notifies when a Milestone has been reached or missed.

      It informs on all waypoints (passed or missed) that are of type MilestoneType.STOPOVER but excludes the starting waypoint. Waypoints of type MilestoneType.PASSTHROUGH are excluded, by default, but can be included via NavigatorInterface.isPassthroughWaypointsHandlingEnabled(). Milestone status notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getMilestoneStatusListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about the arrival at each Milestone or missing it.

    • setMilestoneStatusListener

      public void setMilestoneStatusListener(@Nullable MilestoneStatusListener value)

      Sets the listener that notifies when a Milestone has been reached or missed.

      It informs on all waypoints (passed or missed) that are of type MilestoneType.STOPOVER but excludes the starting waypoint. Waypoints of type MilestoneType.PASSTHROUGH are excluded, by default, but can be included via NavigatorInterface.isPassthroughWaypointsHandlingEnabled(). Milestone status notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setMilestoneStatusListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about the arrival at each Milestone or missing it.

    • getDestinationReachedListener

      @Nullable public DestinationReachedListener getDestinationReachedListener()

      Gets the listener that notify when the destination has been reached.

      Destination reached notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getDestinationReachedListener in interface NavigatorInterface
      Returns:

      Object to receive the notification about the arrival at the destination.

    • setDestinationReachedListener

      public void setDestinationReachedListener(@Nullable DestinationReachedListener value)

      Sets the listener that notify when the destination has been reached.

      Destination reached notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setDestinationReachedListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive the notification about the arrival at the destination.

    • getSpeedWarningListener

      @Nullable public SpeedWarningListener getSpeedWarningListener()

      Gets the listener to receive notifications when a speed limit on a road is exceeded or driving speed is restored back to normal.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getSpeedWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notifications when a speed limit on a road is exceeded or driving speed is restored back to normal.

    • setSpeedWarningListener

      public void setSpeedWarningListener(@Nullable SpeedWarningListener value)

      Sets the listener to receive notifications when a speed limit on a road is exceeded or driving speed is restored back to normal.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setSpeedWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications when a speed limit on a road is exceeded or driving speed is restored back to normal.

    • getManeuverViewLaneAssistanceListener

      @Nullable public ManeuverViewLaneAssistanceListener getManeuverViewLaneAssistanceListener()

      Gets the listener to receive maneuver view lane assistance notifications.

      Maneuver view lane assistance notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getManeuverViewLaneAssistanceListener in interface NavigatorInterface
      Returns:

      Object to receive maneuver view lane assistance notifications.

    • setManeuverViewLaneAssistanceListener

      public void setManeuverViewLaneAssistanceListener(@Nullable ManeuverViewLaneAssistanceListener value)

      Sets the listener to receive maneuver view lane assistance notifications.

      Maneuver view lane assistance notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setManeuverViewLaneAssistanceListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive maneuver view lane assistance notifications.

    • getCurrentSituationLaneAssistanceViewListener

      @Nullable public CurrentSituationLaneAssistanceViewListener getCurrentSituationLaneAssistanceViewListener()

      Gets the listener to receive current situation lane assistance view notifications.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getCurrentSituationLaneAssistanceViewListener in interface NavigatorInterface
      Returns:

      Object to receive current situation lane assistance view notifications.

    • setCurrentSituationLaneAssistanceViewListener

      public void setCurrentSituationLaneAssistanceViewListener(@Nullable CurrentSituationLaneAssistanceViewListener value)

      Sets the listener to receive current situation lane assistance view notifications.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setCurrentSituationLaneAssistanceViewListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive current situation lane assistance view notifications.

    • getEnvironmentalZoneWarningListener

      @Nullable public EnvironmentalZoneWarningListener getEnvironmentalZoneWarningListener()

      Gets the listener to receive current environmental zones notifications.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getEnvironmentalZoneWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notification on approaching environmental zones.

    • setEnvironmentalZoneWarningListener

      public void setEnvironmentalZoneWarningListener(@Nullable EnvironmentalZoneWarningListener value)

      Sets the listener to receive current environmental zones notifications.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setEnvironmentalZoneWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notification on approaching environmental zones.

    • getJunctionViewLaneAssistanceListener

      @Nullable public JunctionViewLaneAssistanceListener getJunctionViewLaneAssistanceListener()

      Gets the listener to receive junction view lane assistance notifications.

      Junction view lane assistance notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getJunctionViewLaneAssistanceListener in interface NavigatorInterface
      Returns:

      Object to receive junction view lane assistance notifications.

    • setJunctionViewLaneAssistanceListener

      public void setJunctionViewLaneAssistanceListener(@Nullable JunctionViewLaneAssistanceListener value)

      Sets the listener to receive junction view lane assistance notifications.

      Junction view lane assistance notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setJunctionViewLaneAssistanceListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive junction view lane assistance notifications.

    • getSafetyCameraWarningListener

      @Nullable public SafetyCameraWarningListener getSafetyCameraWarningListener()

      Gets the listener to receive safety camera warning notifications.

      If a listener is present, notifications about safety speed cameras will be also sent via SafetyCameraWarningListener. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getSafetyCameraWarningListener in interface NavigatorInterface
      Returns:

      Object to receive safety camera warner notifications.

    • setSafetyCameraWarningListener

      public void setSafetyCameraWarningListener(@Nullable SafetyCameraWarningListener value)

      Sets the listener to receive safety camera warning notifications.

      If a listener is present, notifications about safety speed cameras will be also sent via SafetyCameraWarningListener. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setSafetyCameraWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive safety camera warner notifications.

    • getSafetyCameraWarningOptions

      @NonNull public SafetyCameraWarningOptions getSafetyCameraWarningOptions()

      Gets safety camera warning options to be passed to SafetyCameraWarningListener.

      These options allow the enabling or disabling the text notification for the warner.

      Specified by:
      getSafetyCameraWarningOptions in interface NavigatorInterface
      Returns:

      Safety camera warning options to be passed to SafetyCameraWarningListener.

    • setSafetyCameraWarningOptions

      public void setSafetyCameraWarningOptions(@NonNull SafetyCameraWarningOptions value)

      Sets safety camera warning options to be passed to SafetyCameraWarningListener.

      These options allow the enabling or disabling the text notification for the warner.

      Specified by:
      setSafetyCameraWarningOptions in interface NavigatorInterface
      Parameters:
      value -

      Safety camera warning options to be passed to SafetyCameraWarningListener.

    • getDangerZoneWarningListener

      @Nullable public DangerZoneWarningListener getDangerZoneWarningListener()

      Gets the listener to receive current danger zones notifications.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getDangerZoneWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notification on approaching danger zones.

    • setDangerZoneWarningListener

      public void setDangerZoneWarningListener(@Nullable DangerZoneWarningListener value)

      Sets the listener to receive current danger zones notifications.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setDangerZoneWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notification on approaching danger zones.

    • getTruckRestrictionsWarningListener

      @Nullable public TruckRestrictionsWarningListener getTruckRestrictionsWarningListener()

      Gets the listener to receive notifications about truck restrictions on the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getTruckRestrictionsWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about truck restrictions on the current road.

    • setTruckRestrictionsWarningListener

      public void setTruckRestrictionsWarningListener(@Nullable TruckRestrictionsWarningListener value)

      Sets the listener to receive notifications about truck restrictions on the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setTruckRestrictionsWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about truck restrictions on the current road.

    • getTruckRestrictionsWarningOptions

      @NonNull public TruckRestrictionsWarningOptions getTruckRestrictionsWarningOptions()

      Gets truck restrictions warning options that allow to filter truck restrictions to be passed to TruckRestrictionsWarningListener.

      Specified by:
      getTruckRestrictionsWarningOptions in interface NavigatorInterface
      Returns:

      Truck restrictions warning options that allow to filter truck restrictions to be passed to TruckRestrictionsWarningListener.

    • setTruckRestrictionsWarningOptions

      public void setTruckRestrictionsWarningOptions(@NonNull TruckRestrictionsWarningOptions value)

      Sets truck restrictions warning options that allow to filter truck restrictions to be passed to TruckRestrictionsWarningListener.

      Specified by:
      setTruckRestrictionsWarningOptions in interface NavigatorInterface
      Parameters:
      value -

      Truck restrictions warning options that allow to filter truck restrictions to be passed to TruckRestrictionsWarningListener.

    • getPostActionListener

      @Nullable public PostActionListener getPostActionListener()

      Gets the listener to receive post action notifications, such as a charge action at a charging station.

      Post actions notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getPostActionListener in interface NavigatorInterface
      Returns:

      Object to receive post action notifications, such as a charge action at a charging station.

    • setPostActionListener

      public void setPostActionListener(@Nullable PostActionListener value)

      Sets the listener to receive post action notifications, such as a charge action at a charging station.

      Post actions notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setPostActionListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive post action notifications, such as a charge action at a charging station.

    • getSpeedLimitListener

      @Nullable public SpeedLimitListener getSpeedLimitListener()

      Gets the listener to receive notifications about the speed limit of the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getSpeedLimitListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about the speed limit of the current road.

    • setSpeedLimitListener

      public void setSpeedLimitListener(@Nullable SpeedLimitListener value)

      Sets the listener to receive notifications about the speed limit of the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setSpeedLimitListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about the speed limit of the current road.

    • getRoadTextsListener

      @Nullable public RoadTextsListener getRoadTextsListener()

      Gets the listener to receive notifications about the textual attributes of the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getRoadTextsListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about the textual attributes of the current road.

    • setRoadTextsListener

      public void setRoadTextsListener(@Nullable RoadTextsListener value)

      Sets the listener to receive notifications about the textual attributes of the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setRoadTextsListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about the textual attributes of the current road.

    • getRoadAttributesListener

      @Nullable public RoadAttributesListener getRoadAttributesListener()

      Gets the listener to receive notifications about attributes of the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getRoadAttributesListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about attributes of the current road.

    • setRoadAttributesListener

      public void setRoadAttributesListener(@Nullable RoadAttributesListener value)

      Sets the listener to receive notifications about attributes of the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setRoadAttributesListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about attributes of the current road.

    • getRoadSignWarningListener

      @Nullable public RoadSignWarningListener getRoadSignWarningListener()

      Gets the listener to receive notifications about road signs on the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getRoadSignWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about road signs on the current road.

    • setRoadSignWarningListener

      public void setRoadSignWarningListener(@Nullable RoadSignWarningListener value)

      Sets the listener to receive notifications about road signs on the current road. Note: This RoadSignWarningListener will provide school zone warnings only in case the speed limit inside the school zone is different than the default speed limit applicable for cars outside the school zone. For warnings about school zones regardless of their speed limits, the NavigatorInterface.road_sign_warning_listener should be used and the RoadSignWarning.type should be checked for value RoadSignType.SCHOOL_ZONE. The school zone warner is a zone warner, which means that for a school zone there will always be 3 warnings emitted, with the SchoolZoneWarning.distance_type set to DistanceType.AHEAD, DistanceType.REACHED

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setRoadSignWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about road signs on the current road.

    • getRoadSignWarningOptions

      @NonNull public RoadSignWarningOptions getRoadSignWarningOptions()

      Gets road sign warning options that allow to filter road signs to be passed to RoadSignWarningListener.

      Specified by:
      getRoadSignWarningOptions in interface NavigatorInterface
      Returns:

      Road sign warning options that allow to filter road sings to be passed to RoadSignWarningListener.

    • setRoadSignWarningOptions

      public void setRoadSignWarningOptions(@NonNull RoadSignWarningOptions value)

      Sets road sign warning options that allow to filter road signs to be passed to RoadSignWarningListener.

      Specified by:
      setRoadSignWarningOptions in interface NavigatorInterface
      Parameters:
      value -

      Road sign warning options that allow to filter road sings to be passed to RoadSignWarningListener.

    • getSchoolZoneWarningListener

      @Nullable public SchoolZoneWarningListener getSchoolZoneWarningListener()

      Gets the listener to receive notifications about school zones on the current road.

      Setting null value to the listener will unset the listener. school zones on the current road. It returns null when no listener is set by an user.

      Specified by:
      getSchoolZoneWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about school zones on the current road.

    • setSchoolZoneWarningListener

      public void setSchoolZoneWarningListener(@Nullable SchoolZoneWarningListener value)

      Sets the listener to receive notifications about school zones on the current road.

      Setting null value to the listener will unset the listener. school zones on the current road. It returns null when no listener is set by an user.

      Specified by:
      setSchoolZoneWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about school zones on the current road.

    • getSchoolZoneWarningOptions

      @NonNull public SchoolZoneWarningOptions getSchoolZoneWarningOptions()

      Gets school zone warning options that allow to configure school zone notifications to be passed to SchoolZoneWarningListener.

      It allow to configure school zone notifications to be passed to SchoolZoneWarningListener.

      Specified by:
      getSchoolZoneWarningOptions in interface NavigatorInterface
      Returns:

      School zone warning options

    • setSchoolZoneWarningOptions

      public void setSchoolZoneWarningOptions(@NonNull SchoolZoneWarningOptions value)

      Sets school zone warning options that allow to configure school zone notifications to be passed to SchoolZoneWarningListener.

      It allow to configure school zone notifications to be passed to SchoolZoneWarningListener.

      Specified by:
      setSchoolZoneWarningOptions in interface NavigatorInterface
      Parameters:
      value -

      School zone warning options

    • getRealisticViewWarningListener

      @Nullable public RealisticViewWarningListener getRealisticViewWarningListener()

      Gets the listener to receive notifications about junction views on the current road.

      Setting null value to the listener will unset the listener. This feature requires a map version greater or equal to 67 in order to function properly. It returns null when no listener is set by an user.

      Specified by:
      getRealisticViewWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about junction views on the current road.

    • setRealisticViewWarningListener

      public void setRealisticViewWarningListener(@Nullable RealisticViewWarningListener value)

      Sets the listener to receive notifications about junction views on the current road.

      Setting null value to the listener will unset the listener. This feature requires a map version greater or equal to 67 in order to function properly. It returns null when no listener is set by an user.

      Specified by:
      setRealisticViewWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about junction views on the current road.

    • getRealisticViewWarningOptions

      @NonNull public RealisticViewWarningOptions getRealisticViewWarningOptions()

      Gets realistic view warning options that allow to filter realistic views to be passed to RealisticViewWarningListener.

      It allow to filter realistic views to be passed to RealisticViewWarningListener.

      • This feature requires a map version greater or equal to 67 in order to function properly.
      Specified by:
      getRealisticViewWarningOptions in interface NavigatorInterface
      Returns:

      Realistic view warning options.

    • setRealisticViewWarningOptions

      public void setRealisticViewWarningOptions(@NonNull RealisticViewWarningOptions value)

      Sets realistic view warning options that allow to filter realistic views to be passed to RealisticViewWarningListener.

      It allow to filter realistic views to be passed to RealisticViewWarningListener.

      • This feature requires a map version greater or equal to 67 in order to function properly.
      Specified by:
      setRealisticViewWarningOptions in interface NavigatorInterface
      Parameters:
      value -

      Realistic view warning options.

    • getBorderCrossingWarningListener

      @Nullable public BorderCrossingWarningListener getBorderCrossingWarningListener()

      Gets the listener to receive notifications about border crossings on the current road.

      Border crossing notifications are given only if a route is present. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getBorderCrossingWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about border crossings on the current road.

    • setBorderCrossingWarningListener

      public void setBorderCrossingWarningListener(@Nullable BorderCrossingWarningListener value)

      Sets the listener to receive notifications about border crossings on the current road.

      Border crossing notifications are given only if a route is present. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setBorderCrossingWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about border crossings on the current road.

    • getBorderCrossingWarningOptions

      @NonNull public BorderCrossingWarningOptions getBorderCrossingWarningOptions()

      Gets border crossing warning options to be passed to BorderCrossingWarningListener.

      allow the filtering of the border crossing warnings received and set the notification distances.

      Specified by:
      getBorderCrossingWarningOptions in interface NavigatorInterface
      Returns:

      Border crossing warning options to be passed to BorderCrossingWarningListener. These options

    • setBorderCrossingWarningOptions

      public void setBorderCrossingWarningOptions(@NonNull BorderCrossingWarningOptions value)

      Sets border crossing warning options to be passed to BorderCrossingWarningListener.

      allow the filtering of the border crossing warnings received and set the notification distances.

      Specified by:
      setBorderCrossingWarningOptions in interface NavigatorInterface
      Parameters:
      value -

      Border crossing warning options to be passed to BorderCrossingWarningListener. These options

    • getTollStopWarningListener

      @Nullable public TollStopWarningListener getTollStopWarningListener()

      Gets the listener to receive notifications about the the upcoming toll stop.

      Setting null value to the listener will unset the listener. This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

      Specified by:
      getTollStopWarningListener in interface NavigatorInterface
      Returns:

      Object to receive information on the upcoming toll stop.

    • setTollStopWarningListener

      public void setTollStopWarningListener(@Nullable TollStopWarningListener value)

      Sets the listener to receive notifications about the upcoming toll stop.

      Setting null value to the listener will unset the listener. This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

      Specified by:
      setTollStopWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive information on the upcoming toll stop.

    • getRailwayCrossingWarningListener

      @Nullable public RailwayCrossingWarningListener getRailwayCrossingWarningListener()

      Gets the listener to receive notifications about railway crossings on the current road.

      Railway crossing notifications are given regardless if a route is set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getRailwayCrossingWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about railway crossings on the current road.

    • setRailwayCrossingWarningListener

      public void setRailwayCrossingWarningListener(@Nullable RailwayCrossingWarningListener value)

      Sets the listener to receive notifications about railway crossings on the current road.

      Railway crossing notifications are given regardless if a route is set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setRailwayCrossingWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about railway crossings on the current road.

    • getLowSpeedZoneWarningListener

      @Nullable public LowSpeedZoneWarningListener getLowSpeedZoneWarningListener()

      Gets the listener to receive notifications about low speed zones on the current road.

      Low speed zone notifications are given regardless if a route is set. This listener is currently available only for Japan. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getLowSpeedZoneWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about low speed zones on the current road.

    • setLowSpeedZoneWarningListener

      public void setLowSpeedZoneWarningListener(@Nullable LowSpeedZoneWarningListener value)

      Sets the listener to receive notifications about low speed zones on the current road.

      Low speed zone notifications are given regardless if a route is set. This listener is currently available only for Japan. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setLowSpeedZoneWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about low speed zones on the current road.

    • getTrafficMergeWarningListener

      @Nullable public TrafficMergeWarningListener getTrafficMergeWarningListener()

      Gets the listener to receive notifications about merging traffic to the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getTrafficMergeWarningListener in interface NavigatorInterface
      Returns:

      Object to receive notifications about merging traffic to the current road.

    • setTrafficMergeWarningListener

      public void setTrafficMergeWarningListener(@Nullable TrafficMergeWarningListener value)

      Sets the listener to receive notifications about merging traffic to the current road.

      Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setTrafficMergeWarningListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive notifications about merging traffic to the current road.

    • getTrafficMergeWarningOptions

      @NonNull public TrafficMergeWarningOptions getTrafficMergeWarningOptions()

      Gets merging traffic warning options that allow to configure merging traffic notifications to be passed to TrafficMergeWarningListener.

      Specified by:
      getTrafficMergeWarningOptions in interface NavigatorInterface
      Returns:

      Merging traffic warning options that allow to configure merging traffic notifications to be passed to TrafficMergeWarningListener.

    • setTrafficMergeWarningOptions

      public void setTrafficMergeWarningOptions(@NonNull TrafficMergeWarningOptions value)

      Sets merging traffic warning options that allow to configure merging traffic notifications to be passed to TrafficMergeWarningListener.

      Specified by:
      setTrafficMergeWarningOptions in interface NavigatorInterface
      Parameters:
      value -

      Merging traffic warning options that allow to configure merging traffic notifications to be passed to TrafficMergeWarningListener.

    • getOffRoadDestinationReachedListener

      @Nullable public OffRoadDestinationReachedListener getOffRoadDestinationReachedListener()

      Gets the listener that notifies when the off-road destination has been reached.

      Off-road destination reached notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getOffRoadDestinationReachedListener in interface NavigatorInterface
      Returns:

      Object to receive the notification about the arrival at the off-road destination.

    • setOffRoadDestinationReachedListener

      public void setOffRoadDestinationReachedListener(@Nullable OffRoadDestinationReachedListener value)

      Sets the listener that notifies when the off-road destination has been reached.

      Off-road destination reached notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setOffRoadDestinationReachedListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive the notification about the arrival at the off-road destination.

    • getOffRoadProgressListener

      @Nullable public OffRoadProgressListener getOffRoadProgressListener()

      Gets the listener that notifies about off-road progress.

      Off-road progress notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      getOffRoadProgressListener in interface NavigatorInterface
      Returns:

      Object to receive the notification about the off-road progress.

    • setOffRoadProgressListener

      public void setOffRoadProgressListener(@Nullable OffRoadProgressListener value)

      Sets the listener that notifies about off-road progress.

      Off-road progress notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user.

      Specified by:
      setOffRoadProgressListener in interface NavigatorInterface
      Parameters:
      value -

      Object to receive the notification about the off-road progress.

    • getManeuverNotificationOptions

      @NonNull public ManeuverNotificationOptions getManeuverNotificationOptions()

      Gets the maneuver notification options.

      Notifications are only available if a route is present.

      Specified by:
      getManeuverNotificationOptions in interface NavigatorInterface
      Returns:

      Options used for maneuver notifications.

    • setManeuverNotificationOptions

      public void setManeuverNotificationOptions(@NonNull ManeuverNotificationOptions value)

      Sets the maneuver notification options.

      Notifications are only available if a route is present.

      Specified by:
      setManeuverNotificationOptions in interface NavigatorInterface
      Parameters:
      value -

      Options used for maneuver notifications.

    • getEventTextOptions

      @NonNull public EventTextOptions getEventTextOptions()

      Gets the text notification options.

      Notifications are only available if a route is present.

      Specified by:
      getEventTextOptions in interface NavigatorInterface
      Returns:

      Options used for text notifications.

    • setEventTextOptions

      public void setEventTextOptions(@NonNull EventTextOptions value)

      Sets the text notification options.

      Notifications are only available if a route is present.

      Specified by:
      setEventTextOptions in interface NavigatorInterface
      Parameters:
      value -

      Options used for text notifications.

    • getSpeedWarningOptions

      @NonNull public SpeedWarningOptions getSpeedWarningOptions()

      Gets the speed warning options.

      Specified by:
      getSpeedWarningOptions in interface NavigatorInterface
      Returns:

      Options used for the speed warning feature.

    • setSpeedWarningOptions

      public void setSpeedWarningOptions(@NonNull SpeedWarningOptions value)

      Sets the speed warning options.

      Specified by:
      setSpeedWarningOptions in interface NavigatorInterface
      Parameters:
      value -

      Options used for the speed warning feature.

    • isEnableTunnelExtrapolation

      public boolean isEnableTunnelExtrapolation()

      Return true if tunnel extrapolation is enabled otherwise false.

      By default the tunnel extrapolation is enabled.

      Specified by:
      isEnableTunnelExtrapolation in interface NavigatorInterface
      Returns:

      Defines whether to enable or disable tunnel extrapolation.

    • setEnableTunnelExtrapolation

      public void setEnableTunnelExtrapolation(boolean value)

      Set to true to enable tunnel extrapolation, set to false to disable tunnel extrapolation.

      By default the tunnel extrapolation is enabled.

      Specified by:
      setEnableTunnelExtrapolation in interface NavigatorInterface
      Parameters:
      value -

      Defines whether to enable or disable tunnel extrapolation.

    • isPassthroughWaypointsHandlingEnabled

      public boolean isPassthroughWaypointsHandlingEnabled()

      Return true if handling of passthrough waypoints is enabled, otherwise - false.

      By default the handling of passthrough waypoints is disabled.

      Specified by:
      isPassthroughWaypointsHandlingEnabled in interface NavigatorInterface
      Returns:

      Defines whether to enable or disable handling of passthrough waypoints.

    • setPassthroughWaypointsHandlingEnabled

      public void setPassthroughWaypointsHandlingEnabled(boolean value)

      Set to true enables handling of passthrough waypoints, set to false disables handling of passthrough waypoints.

      By default the handling of passthrough waypoints is disabled.

      Specified by:
      setPassthroughWaypointsHandlingEnabled in interface NavigatorInterface
      Parameters:
      value -

      Defines whether to enable or disable handling of passthrough waypoints.

    • getTrafficOnRoute

      @Nullable public TrafficOnRoute getTrafficOnRoute()

      Gets the traffic information for the current route.

      This impacts RouteProgress updates as the duration of the SectionProgress might change. However, the remaining distance and the route geometry will remain unchanged.

      Specified by:
      getTrafficOnRoute in interface NavigatorInterface
      Returns:

      Traffic information for the current route.

    • setTrafficOnRoute

      public void setTrafficOnRoute(@Nullable TrafficOnRoute value)

      Sets the traffic information for the current route.

      This impacts RouteProgress updates as the duration of the SectionProgress might change. However, the remaining distance and the route geometry will remain unchanged.

      Specified by:
      setTrafficOnRoute in interface NavigatorInterface
      Parameters:
      value -

      Traffic information for the current route.