Package com.here.sdk.navigation

Interface NavigatorInterface

All Superinterfaces:
LocationListener
All Known Implementing Classes:
Navigator, VisualNavigator
public interface NavigatorInterface extends LocationListener

This interface provides the basic functionality needed to run a navigation session.

  • Method Details

    • getManeuver

      @Nullable Maneuver getManeuver(int index)

      Returns maneuver at the given index.

      Parameters:
      index -

      The index of maneuver requested.

      Returns:

      The maneuver if it exists or otherwise null.

    • getManeuverNotificationTimingOptions

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

      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

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

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

      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

      @Deprecated @NonNull WarningNotificationDistances getWarningNotificationDistances(@NonNull WarningType warningType)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.getWarningNotificationDistances() method instead.

      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.

      Parameters:
      warningType -

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

      Returns:

      The notification distances for the given warning type.

    • setWarningNotificationDistances

      @Deprecated boolean setWarningNotificationDistances(@NonNull WarningType warningType, @NonNull WarningNotificationDistances warningNotificationDistances)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.setWarningNotificationDistances() method instead.

      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.

      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

      void repeatLastManeuverNotification()

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

    • calculateRemainingDistanceInMeters

      @Nullable Integer calculateRemainingDistanceInMeters(@NonNull GeoCoordinates coordinates)

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

      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

      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.

      Parameters:
      key -

      Option name

      value -

      New option value

    • getRoute

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

      Returns:

      The route to navigate.

    • setRoute

      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.

      Parameters:
      value -

      The route to navigate.

    • getTrackingTransportProfile

      @Deprecated @Nullable TransportProfile getTrackingTransportProfile()
      Deprecated.

      Will be removed in v4.28.0. Use NavigatorInterface.trackingTransportSpecification instead.

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

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

    • setTrackingTransportProfile

      @Deprecated void setTrackingTransportProfile(@Nullable TransportProfile value)
      Deprecated.

      Will be removed in v4.28.0. Use NavigatorInterface.trackingTransportSpecification instead.

      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.
      Parameters:
      value -

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

    • getTrackingTransportSpecification

      @Nullable TransportSpecification getTrackingTransportSpecification()

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

      Properly setting the transport specification optimizes the navigation experience, and improves resource consumption. An TransportSpecification must have the TransportSpecification.transportMode set. A transport specification can have several parameters defined such as VehicleSpecification.lengthInCentimeters defined in TransportSpecification.vehicleSpecification to set the source of information describing the vehicle. By default the TransportSpecification will have the transport mode set to TransportMode.CAR.

      Currently used members of TransportSpecification

      Returns:

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

    • setTrackingTransportSpecification

      void setTrackingTransportSpecification(@Nullable TransportSpecification value)

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

      Properly setting the transport specification optimizes the navigation experience, and improves resource consumption. An TransportSpecification must have the TransportSpecification.transportMode set. A transport specification can have several parameters defined such as VehicleSpecification.lengthInCentimeters defined in TransportSpecification.vehicleSpecification to set the source of information describing the vehicle. By default the TransportSpecification will have the transport mode set to TransportMode.CAR.

      Currently used members of TransportSpecification

      Parameters:
      value -

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

    • getNavigableLocationListener

      @Nullable NavigableLocationListener getNavigableLocationListener()

      Gets the listener that notifies current location updates.

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

      Returns:

      Object to receive notifications about the current location.

    • setNavigableLocationListener

      void setNavigableLocationListener(@Nullable NavigableLocationListener value)

      Sets the listener that notifies current location updates.

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

      Parameters:
      value -

      Object to receive notifications about the current location.

    • getRouteProgressListener

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

      Returns:

      Object to receive notifications about navigation route progress.

    • setRouteProgressListener

      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.

      Parameters:
      value -

      Object to receive notifications about navigation route progress.

    • getRouteDeviationListener

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

      Returns:

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

    • setRouteDeviationListener

      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.

      Parameters:
      value -

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

    • getEventTextListener

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

      Returns:

      Object to receive text notifications when they are available.

    • setEventTextListener

      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.

      Parameters:
      value -

      Object to receive text notifications when they are available.

    • getMilestoneStatusListener

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

      Returns:

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

    • setMilestoneStatusListener

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

      Parameters:
      value -

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

    • getDestinationReachedListener

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

      Returns:

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

    • setDestinationReachedListener

      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.

      Parameters:
      value -

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

    • getSpeedWarningListener

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

      Returns:

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

    • setSpeedWarningListener

      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.

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

      Returns:

      Object to receive maneuver view lane assistance notifications.

    • setManeuverViewLaneAssistanceListener

      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.

      Parameters:
      value -

      Object to receive maneuver view lane assistance notifications.

    • getCurrentSituationLaneAssistanceViewListener

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

      Returns:

      Object to receive current situation lane assistance view notifications.

    • setCurrentSituationLaneAssistanceViewListener

      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.

      Parameters:
      value -

      Object to receive current situation lane assistance view notifications.

    • getEnvironmentalZoneWarningListener

      @Deprecated @Nullable EnvironmentalZoneWarningListener getEnvironmentalZoneWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

      Object to receive notification on approaching environmental zones.

    • setEnvironmentalZoneWarningListener

      @Deprecated void setEnvironmentalZoneWarningListener(@Nullable EnvironmentalZoneWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

      Object to receive notification on approaching environmental zones.

    • getJunctionViewLaneAssistanceListener

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

      Returns:

      Object to receive junction view lane assistance notifications.

    • setJunctionViewLaneAssistanceListener

      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.

      Parameters:
      value -

      Object to receive junction view lane assistance notifications.

    • getSafetyCameraWarningListener

      @Deprecated @Nullable SafetyCameraWarningListener getSafetyCameraWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

      Object to receive safety camera warner notifications.

    • setSafetyCameraWarningListener

      @Deprecated void setSafetyCameraWarningListener(@Nullable SafetyCameraWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

      Object to receive safety camera warner notifications.

    • getSafetyCameraWarningOptions

      @Deprecated @NonNull SafetyCameraWarningOptions getSafetyCameraWarningOptions()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

      Gets safety camera warning options to be passed to SafetyCameraWarningListener.

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

      Returns:

      Safety camera warning options to be passed to SafetyCameraWarningListener.

    • setSafetyCameraWarningOptions

      @Deprecated void setSafetyCameraWarningOptions(@NonNull SafetyCameraWarningOptions value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

      Sets safety camera warning options to be passed to SafetyCameraWarningListener.

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

      Parameters:
      value -

      Safety camera warning options to be passed to SafetyCameraWarningListener.

    • getDangerZoneWarningListener

      @Deprecated @Nullable DangerZoneWarningListener getDangerZoneWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

      Object to receive notification on approaching danger zones.

    • setDangerZoneWarningListener

      @Deprecated void setDangerZoneWarningListener(@Nullable DangerZoneWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

      Object to receive notification on approaching danger zones.

    • getTruckRestrictionsWarningListener

      @Deprecated @Nullable TruckRestrictionsWarningListener getTruckRestrictionsWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

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

    • setTruckRestrictionsWarningListener

      @Deprecated void setTruckRestrictionsWarningListener(@Nullable TruckRestrictionsWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

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

    • getWarnerEngine

      @NonNull WarnerEngine getWarnerEngine()

      Gets the warner engine used by the navigator.

      This engine can be used to configure navigation warnings.

      Returns:

      Warner engine used by the navigator.

    • getTruckRestrictionsWarningOptions

      @Deprecated @NonNull TruckRestrictionsWarningOptions getTruckRestrictionsWarningOptions()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

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

      Returns:

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

    • setTruckRestrictionsWarningOptions

      @Deprecated void setTruckRestrictionsWarningOptions(@NonNull TruckRestrictionsWarningOptions value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

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

      Parameters:
      value -

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

    • getPostActionListener

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

      Returns:

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

    • setPostActionListener

      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.

      Parameters:
      value -

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

    • getSpeedLimitListener

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

      Returns:

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

    • setSpeedLimitListener

      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.

      Parameters:
      value -

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

    • getRoadTextsListener

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

      Returns:

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

    • setRoadTextsListener

      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.

      Parameters:
      value -

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

    • getRoadAttributesListener

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

      Returns:

      Object to receive notifications about attributes of the current road.

    • setRoadAttributesListener

      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.

      Parameters:
      value -

      Object to receive notifications about attributes of the current road.

    • getRoadSignWarningListener

      @Deprecated @Nullable RoadSignWarningListener getRoadSignWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

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

    • setRoadSignWarningListener

      @Deprecated void setRoadSignWarningListener(@Nullable RoadSignWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

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

    • getRoadSignWarningOptions

      @Deprecated @NonNull RoadSignWarningOptions getRoadSignWarningOptions()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

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

      Returns:

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

    • setRoadSignWarningOptions

      @Deprecated void setRoadSignWarningOptions(@NonNull RoadSignWarningOptions value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

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

      Parameters:
      value -

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

    • getSchoolZoneWarningListener

      @Deprecated @Nullable SchoolZoneWarningListener getSchoolZoneWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

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

    • setSchoolZoneWarningListener

      @Deprecated void setSchoolZoneWarningListener(@Nullable SchoolZoneWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

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

    • getSchoolZoneWarningOptions

      @Deprecated @NonNull SchoolZoneWarningOptions getSchoolZoneWarningOptions()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

      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.

      Returns:

      School zone warning options

    • setSchoolZoneWarningOptions

      @Deprecated void setSchoolZoneWarningOptions(@NonNull SchoolZoneWarningOptions value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

      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.

      Parameters:
      value -

      School zone warning options

    • getRealisticViewWarningListener

      @Deprecated @Nullable RealisticViewWarningListener getRealisticViewWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

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

    • setRealisticViewWarningListener

      @Deprecated void setRealisticViewWarningListener(@Nullable RealisticViewWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

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

    • getRealisticViewWarningOptions

      @Deprecated @NonNull RealisticViewWarningOptions getRealisticViewWarningOptions()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

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

      Realistic view warning options.

    • setRealisticViewWarningOptions

      @Deprecated void setRealisticViewWarningOptions(@NonNull RealisticViewWarningOptions value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

      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.
      Parameters:
      value -

      Realistic view warning options.

    • getBorderCrossingWarningListener

      @Deprecated @Nullable BorderCrossingWarningListener getBorderCrossingWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

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

    • setBorderCrossingWarningListener

      @Deprecated void setBorderCrossingWarningListener(@Nullable BorderCrossingWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

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

    • getBorderCrossingWarningOptions

      @Deprecated @NonNull BorderCrossingWarningOptions getBorderCrossingWarningOptions()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

      Gets border crossing warning options to be passed to BorderCrossingWarningListener.

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

      Returns:

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

    • setBorderCrossingWarningOptions

      @Deprecated void setBorderCrossingWarningOptions(@NonNull BorderCrossingWarningOptions value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

      Sets border crossing warning options to be passed to BorderCrossingWarningListener.

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

      Parameters:
      value -

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

    • getTollStopWarningListener

      @Deprecated @Nullable TollStopWarningListener getTollStopWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

      Object to receive information on the upcoming toll stop.

    • setTollStopWarningListener

      @Deprecated void setTollStopWarningListener(@Nullable TollStopWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

      Object to receive information on the upcoming toll stop.

    • getRailwayCrossingWarningListener

      @Deprecated @Nullable RailwayCrossingWarningListener getRailwayCrossingWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

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

    • setRailwayCrossingWarningListener

      @Deprecated void setRailwayCrossingWarningListener(@Nullable RailwayCrossingWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

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

    • getLowSpeedZoneWarningListener

      @Deprecated @Nullable LowSpeedZoneWarningListener getLowSpeedZoneWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

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

    • setLowSpeedZoneWarningListener

      @Deprecated void setLowSpeedZoneWarningListener(@Nullable LowSpeedZoneWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

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

    • getTrafficMergeWarningListener

      @Deprecated @Nullable TrafficMergeWarningListener getTrafficMergeWarningListener()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Returns:

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

    • setTrafficMergeWarningListener

      @Deprecated void setTrafficMergeWarningListener(@Nullable TrafficMergeWarningListener value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.addWarningListener() method with own WarningListener implementation as parameter instead.

      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.

      Parameters:
      value -

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

    • getTrafficMergeWarningOptions

      @Deprecated @NonNull TrafficMergeWarningOptions getTrafficMergeWarningOptions()
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

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

      Returns:

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

    • setTrafficMergeWarningOptions

      @Deprecated void setTrafficMergeWarningOptions(@NonNull TrafficMergeWarningOptions value)
      Deprecated.

      Will be removed in v4.29.0. Use the WarnerEngine.WarningOptions property to change these options instead.

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

      Parameters:
      value -

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

    • getOffRoadDestinationReachedListener

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

      Returns:

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

    • setOffRoadDestinationReachedListener

      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.

      Parameters:
      value -

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

    • getOffRoadProgressListener

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

      Returns:

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

    • setOffRoadProgressListener

      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.

      Parameters:
      value -

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

    • getManeuverNotificationOptions

      @NonNull ManeuverNotificationOptions getManeuverNotificationOptions()

      Gets the maneuver notification options.

      Notifications are only available if a route is present.

      Returns:

      Options used for maneuver notifications.

    • setManeuverNotificationOptions

      void setManeuverNotificationOptions(@NonNull ManeuverNotificationOptions value)

      Sets the maneuver notification options.

      Notifications are only available if a route is present.

      Parameters:
      value -

      Options used for maneuver notifications.

    • getEventTextOptions

      @NonNull EventTextOptions getEventTextOptions()

      Gets the text notification options.

      Notifications are only available if a route is present.

      Returns:

      Options used for text notifications.

    • setEventTextOptions

      void setEventTextOptions(@NonNull EventTextOptions value)

      Sets the text notification options.

      Notifications are only available if a route is present.

      Parameters:
      value -

      Options used for text notifications.

    • getSpeedWarningOptions

      @NonNull SpeedWarningOptions getSpeedWarningOptions()

      Gets the speed warning options.

      Returns:

      Options used for the speed warning feature.

    • setSpeedWarningOptions

      void setSpeedWarningOptions(@NonNull SpeedWarningOptions value)

      Sets the speed warning options.

      Parameters:
      value -

      Options used for the speed warning feature.

    • isEnableTunnelExtrapolation

      boolean isEnableTunnelExtrapolation()

      Return true if tunnel extrapolation is enabled otherwise false.

      By default the tunnel extrapolation is enabled.

      Returns:

      Defines whether to enable or disable tunnel extrapolation.

    • setEnableTunnelExtrapolation

      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.

      Parameters:
      value -

      Defines whether to enable or disable tunnel extrapolation.

    • isPassthroughWaypointsHandlingEnabled

      boolean isPassthroughWaypointsHandlingEnabled()

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

      By default the handling of passthrough waypoints is disabled.

      Returns:

      Defines whether to enable or disable handling of passthrough waypoints.

    • setPassthroughWaypointsHandlingEnabled

      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.

      Parameters:
      value -

      Defines whether to enable or disable handling of passthrough waypoints.

    • getTrafficOnRoute

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

      Returns:

      Traffic information for the current route.

    • setTrafficOnRoute

      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.

      Parameters:
      value -

      Traffic information for the current route.

    • getLocationManager

      @NonNull LocationManager getLocationManager()

      Gets the location manager instance used by the navigator.

      Returns:

      The location manager used by the navigator for map-matched location processing.