NavigatorInterface class abstract

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

Implemented types

LocationListener

Implementers

Constructors

NavigatorInterface(void onLocationUpdatedLambda(Location), Maneuver? getManeuverLambda(int), ManeuverNotificationTimingOptions getManeuverNotificationTimingOptionsWithTimingProfileLambda(TransportMode, TimingProfile), bool setManeuverNotificationTimingOptionsWithTimingProfileLambda(TransportMode, TimingProfile, ManeuverNotificationTimingOptions), WarningNotificationDistances getWarningNotificationDistancesLambda(WarningType), bool setWarningNotificationDistancesLambda(WarningType, WarningNotificationDistances), void repeatLastManeuverNotificationLambda(), int? calculateRemainingDistanceInMetersLambda(GeoCoordinates), void setCustomOptionLambda(String, String), Route? routeGetLambda(), void routeSetLambda(Route?), TransportProfile? trackingTransportProfileGetLambda(), void trackingTransportProfileSetLambda(TransportProfile?), NavigableLocationListener? navigableLocationListenerGetLambda(), void navigableLocationListenerSetLambda(NavigableLocationListener?), RouteProgressListener? routeProgressListenerGetLambda(), void routeProgressListenerSetLambda(RouteProgressListener?), RouteDeviationListener? routeDeviationListenerGetLambda(), void routeDeviationListenerSetLambda(RouteDeviationListener?), EventTextListener? eventTextListenerGetLambda(), void eventTextListenerSetLambda(EventTextListener?), MilestoneStatusListener? milestoneStatusListenerGetLambda(), void milestoneStatusListenerSetLambda(MilestoneStatusListener?), DestinationReachedListener? destinationReachedListenerGetLambda(), void destinationReachedListenerSetLambda(DestinationReachedListener?), SpeedWarningListener? speedWarningListenerGetLambda(), void speedWarningListenerSetLambda(SpeedWarningListener?), ManeuverViewLaneAssistanceListener? maneuverViewLaneAssistanceListenerGetLambda(), void maneuverViewLaneAssistanceListenerSetLambda(ManeuverViewLaneAssistanceListener?), CurrentSituationLaneAssistanceViewListener? currentSituationLaneAssistanceViewListenerGetLambda(), void currentSituationLaneAssistanceViewListenerSetLambda(CurrentSituationLaneAssistanceViewListener?), EnvironmentalZoneWarningListener? environmentalZoneWarningListenerGetLambda(), void environmentalZoneWarningListenerSetLambda(EnvironmentalZoneWarningListener?), JunctionViewLaneAssistanceListener? junctionViewLaneAssistanceListenerGetLambda(), void junctionViewLaneAssistanceListenerSetLambda(JunctionViewLaneAssistanceListener?), SafetyCameraWarningListener? safetyCameraWarningListenerGetLambda(), void safetyCameraWarningListenerSetLambda(SafetyCameraWarningListener?), SafetyCameraWarningOptions safetyCameraWarningOptionsGetLambda(), void safetyCameraWarningOptionsSetLambda(SafetyCameraWarningOptions), DangerZoneWarningListener? dangerZoneWarningListenerGetLambda(), void dangerZoneWarningListenerSetLambda(DangerZoneWarningListener?), TruckRestrictionsWarningListener? truckRestrictionsWarningListenerGetLambda(), void truckRestrictionsWarningListenerSetLambda(TruckRestrictionsWarningListener?), TruckRestrictionsWarningOptions truckRestrictionsWarningOptionsGetLambda(), void truckRestrictionsWarningOptionsSetLambda(TruckRestrictionsWarningOptions), PostActionListener? postActionListenerGetLambda(), void postActionListenerSetLambda(PostActionListener?), SpeedLimitListener? speedLimitListenerGetLambda(), void speedLimitListenerSetLambda(SpeedLimitListener?), RoadTextsListener? roadTextsListenerGetLambda(), void roadTextsListenerSetLambda(RoadTextsListener?), RoadAttributesListener? roadAttributesListenerGetLambda(), void roadAttributesListenerSetLambda(RoadAttributesListener?), RoadSignWarningListener? roadSignWarningListenerGetLambda(), void roadSignWarningListenerSetLambda(RoadSignWarningListener?), RoadSignWarningOptions roadSignWarningOptionsGetLambda(), void roadSignWarningOptionsSetLambda(RoadSignWarningOptions), SchoolZoneWarningListener? schoolZoneWarningListenerGetLambda(), void schoolZoneWarningListenerSetLambda(SchoolZoneWarningListener?), SchoolZoneWarningOptions schoolZoneWarningOptionsGetLambda(), void schoolZoneWarningOptionsSetLambda(SchoolZoneWarningOptions), RealisticViewWarningListener? realisticViewWarningListenerGetLambda(), void realisticViewWarningListenerSetLambda(RealisticViewWarningListener?), RealisticViewWarningOptions realisticViewWarningOptionsGetLambda(), void realisticViewWarningOptionsSetLambda(RealisticViewWarningOptions), BorderCrossingWarningListener? borderCrossingWarningListenerGetLambda(), void borderCrossingWarningListenerSetLambda(BorderCrossingWarningListener?), BorderCrossingWarningOptions borderCrossingWarningOptionsGetLambda(), void borderCrossingWarningOptionsSetLambda(BorderCrossingWarningOptions), TollStopWarningListener? tollStopWarningListenerGetLambda(), void tollStopWarningListenerSetLambda(TollStopWarningListener?), RailwayCrossingWarningListener? railwayCrossingWarningListenerGetLambda(), void railwayCrossingWarningListenerSetLambda(RailwayCrossingWarningListener?), LowSpeedZoneWarningListener? lowSpeedZoneWarningListenerGetLambda(), void lowSpeedZoneWarningListenerSetLambda(LowSpeedZoneWarningListener?), TrafficMergeWarningListener? trafficMergeWarningListenerGetLambda(), void trafficMergeWarningListenerSetLambda(TrafficMergeWarningListener?), TrafficMergeWarningOptions trafficMergeWarningOptionsGetLambda(), void trafficMergeWarningOptionsSetLambda(TrafficMergeWarningOptions), OffRoadDestinationReachedListener? offRoadDestinationReachedListenerGetLambda(), void offRoadDestinationReachedListenerSetLambda(OffRoadDestinationReachedListener?), OffRoadProgressListener? offRoadProgressListenerGetLambda(), void offRoadProgressListenerSetLambda(OffRoadProgressListener?), ManeuverNotificationOptions maneuverNotificationOptionsGetLambda(), void maneuverNotificationOptionsSetLambda(ManeuverNotificationOptions), EventTextOptions eventTextOptionsGetLambda(), void eventTextOptionsSetLambda(EventTextOptions), SpeedWarningOptions speedWarningOptionsGetLambda(), void speedWarningOptionsSetLambda(SpeedWarningOptions), bool isEnableTunnelExtrapolationGetLambda(), void isEnableTunnelExtrapolationSetLambda(bool), bool isPassthroughWaypointsHandlingEnabledGetLambda(), void isPassthroughWaypointsHandlingEnabledSetLambda(bool), TrafficOnRoute? trafficOnRouteGetLambda(), void trafficOnRouteSetLambda(TrafficOnRoute?)): This abstract class provides the basic functionality needed to run a navigation session.
factory

Properties

borderCrossingWarningListener ↔ BorderCrossingWarningListener?: Object 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. Gets the listener to receive notifications about border crossings on the current road.
getter/setter pair
borderCrossingWarningOptions ↔ BorderCrossingWarningOptions: Border crossing warning options to be passed to BorderCrossingWarningListener. These options allow the filtering of the border crossing warnings received and set the notification distances. Gets border crossing warning options to be passed to BorderCrossingWarningListener.
getter/setter pair
currentSituationLaneAssistanceViewListener ↔ CurrentSituationLaneAssistanceViewListener?: Object 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. Gets the listener to receive current situation lane assistance view notifications.
getter/setter pair
dangerZoneWarningListener ↔ DangerZoneWarningListener?: Object to receive notification on approaching danger zones. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive current danger zones notifications.
getter/setter pair
destinationReachedListener ↔ DestinationReachedListener?: Object to receive the notification about the arrival at the destination. 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. Gets the listener that notify when the destination has been reached.
getter/setter pair
environmentalZoneWarningListener ↔ EnvironmentalZoneWarningListener?: Object to receive notification on approaching environmental zones. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive current environmental zones notifications.
getter/setter pair
eventTextListener ↔ EventTextListener?: Object to receive text notifications when they are 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. Gets the listener that notifies when a text notification is available.
getter/setter pair
eventTextOptions ↔ EventTextOptions: Options used for text notifications. Notifications are only available if a route is present. Gets the text notification options.
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
isEnableTunnelExtrapolation ↔ bool: Defines whether to enable or disable tunnel extrapolation. By default the tunnel extrapolation is enabled. Return true if tunnel extrapolation is enabled otherwise false.
getter/setter pair
isPassthroughWaypointsHandlingEnabled ↔ bool: Defines whether to enable or disable handling of passthrough waypoints. By default the handling of passthrough waypoints is disabled. Return true if handling of passthrough waypoints is enabled, otherwise - false.
getter/setter pair
junctionViewLaneAssistanceListener ↔ JunctionViewLaneAssistanceListener?: Object 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. Gets the listener to receive junction view lane assistance notifications.
getter/setter pair
lowSpeedZoneWarningListener ↔ LowSpeedZoneWarningListener?: Object 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. Gets the listener to receive notifications about low speed zones on the current road.
getter/setter pair
maneuverNotificationOptions ↔ ManeuverNotificationOptions: Options used for maneuver notifications. Notifications are only available if a route is present. Gets the maneuver notification options.
getter/setter pair
maneuverViewLaneAssistanceListener ↔ ManeuverViewLaneAssistanceListener?: Object 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. Gets the listener to receive maneuver view lane assistance notifications.
getter/setter pair
milestoneStatusListener ↔ MilestoneStatusListener?: Object to receive notifications about the arrival at each Milestone or missing it. 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. Gets the listener that notifies when a Milestone has been reached or missed.
getter/setter pair
navigableLocationListener ↔ NavigableLocationListener?: Object to receive notifications about the current location. It returns null when no listener is set by an user. Gets the listener that notifies current location updates.
getter/setter pair
offRoadDestinationReachedListener ↔ OffRoadDestinationReachedListener?: Object to receive the notification about the arrival at the off-road destination. 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. Gets the listener that notifies when the off-road destination has been reached.
getter/setter pair
offRoadProgressListener ↔ OffRoadProgressListener?: Object to receive the notification about the 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. Gets the listener that notifies about off-road progress.
getter/setter pair
postActionListener ↔ PostActionListener?: Object 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. Gets the listener to receive post action notifications, such as a charge action at a charging station.
getter/setter pair
railwayCrossingWarningListener ↔ RailwayCrossingWarningListener?: Object 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. Gets the listener to receive notifications about railway crossings on the current road.
getter/setter pair
realisticViewWarningListener ↔ RealisticViewWarningListener?: Object 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. Gets the listener to receive notifications about junction views on the current road.
getter/setter pair
realisticViewWarningOptions ↔ RealisticViewWarningOptions: Realistic view warning options. It allow to filter realistic views to be passed to RealisticViewWarningListener.
getter/setter pair
roadAttributesListener ↔ RoadAttributesListener?: Object 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. Gets the listener to receive notifications about attributes of the current road.
getter/setter pair
roadSignWarningListener ↔ RoadSignWarningListener?: Object 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. Gets the listener to receive notifications about road signs on the current road.
getter/setter pair
roadSignWarningOptions ↔ RoadSignWarningOptions: Road sign warning options that allow to filter road sings to be passed to RoadSignWarningListener. Gets road sign warning options that allow to filter road signs to be passed to RoadSignWarningListener.
getter/setter pair
roadTextsListener ↔ RoadTextsListener?: Object 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. Gets the listener to receive notifications about the textual attributes of the current road.
getter/setter pair
route ↔ Route?: 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. Gets the route that is being navigated.
getter/setter pair
routeDeviationListener ↔ RouteDeviationListener?: Object to receive notifications about deviations from the route if any occurs. 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. Gets the listener that notifies when deviation from the route is observed.
getter/setter pair
routeProgressListener ↔ RouteProgressListener?: Object to receive notifications about navigation route progress. 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. Gets the listener that notifies when a route progress change occurs.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
safetyCameraWarningListener ↔ SafetyCameraWarningListener?: Object to receive safety camera warner 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. Gets the listener to receive safety camera warning notifications.
getter/setter pair
safetyCameraWarningOptions ↔ SafetyCameraWarningOptions: Safety camera warning options to be passed to SafetyCameraWarningListener. These options allow the enabling or disabling the text notification for the warner. Gets safety camera warning options to be passed to SafetyCameraWarningListener.
getter/setter pair
schoolZoneWarningListener ↔ SchoolZoneWarningListener?: Object 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. Gets the listener to receive notifications about school zones on the current road.
getter/setter pair
schoolZoneWarningOptions ↔ SchoolZoneWarningOptions: School zone warning options It allow to configure school zone notifications to be passed to SchoolZoneWarningListener. Gets school zone warning options that allow to configure school zone notifications to be passed to SchoolZoneWarningListener.
getter/setter pair
speedLimitListener ↔ SpeedLimitListener?: Object 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. Gets the listener to receive notifications about the speed limit of the current road.
getter/setter pair
speedWarningListener ↔ SpeedWarningListener?: Object 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. Gets the listener to receive notifications when a speed limit on a road is exceeded or driving speed is restored back to normal.
getter/setter pair
speedWarningOptions ↔ SpeedWarningOptions: Options used for the speed warning feature. Gets the speed warning options.
getter/setter pair
tollStopWarningListener ↔ TollStopWarningListener?: Object to receive information on 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. Gets the listener to receive notifications about the the upcoming toll stop.
getter/setter pair
trackingTransportProfile ↔ TransportProfile?: Defines 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.
getter/setter pair
trafficMergeWarningListener ↔ TrafficMergeWarningListener?: Object 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. Gets the listener to receive notifications about merging traffic to the current road.
getter/setter pair
trafficMergeWarningOptions ↔ TrafficMergeWarningOptions: Merging traffic warning options that allow to configure merging traffic notifications to be passed to TrafficMergeWarningListener. Gets merging traffic warning options that allow to configure merging traffic notifications to be passed to TrafficMergeWarningListener.
getter/setter pair
trafficOnRoute ↔ TrafficOnRoute?: 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. Gets the traffic information for the current route.
getter/setter pair
truckRestrictionsWarningListener ↔ TruckRestrictionsWarningListener?: Object 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. Gets the listener to receive notifications about truck restrictions on the current road.
getter/setter pair
truckRestrictionsWarningOptions ↔ TruckRestrictionsWarningOptions: Truck restrictions warning options that allow to filter truck restrictions to be passed to TruckRestrictionsWarningListener. Gets truck restrictions warning options that allow to filter truck restrictions to be passed to TruckRestrictionsWarningListener.
getter/setter pair

Methods

calculateRemainingDistanceInMeters(GeoCoordinates coordinates) → int?: This method calculates the distance between the current position and given coordinates.
getManeuver(int index) → Maneuver?: Returns maneuver at the given index.
getManeuverNotificationTimingOptionsWithTimingProfile(TransportMode transportMode, TimingProfile timingProfile) → ManeuverNotificationTimingOptions: Returns maneuver notification timing options with default values given the combination of transport mode and timing profile.
getWarningNotificationDistances(WarningType warningType) → WarningNotificationDistances: Returns the warning notification distances for the requested warning type.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
onLocationUpdated(Location location) → void: Called each time a new location is available.
inherited
repeatLastManeuverNotification() → void: Call of this function is used to trigger the navigator to repeat the last maneuver notification based on the current position.
setCustomOption(String key, String value) → void: This method sets custom options that controls navigator behavior.
setManeuverNotificationTimingOptionsWithTimingProfile(TransportMode transportMode, TimingProfile timingProfile, ManeuverNotificationTimingOptions options) → bool: Set timing option values for the combination of transport mode and timing profile.
setWarningNotificationDistances(WarningType warningType, WarningNotificationDistances warningNotificationDistances) → bool: Set the warning notification distances for the specified warning types.
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

NavigatorInterface class abstract

Constructors

Properties

Methods

Operators

navigation library