ManeuverNotificationOptions.withAllFields constructor

  1. @Deprecated("Will be removed in v4.23.0. Use the `withDefaults` instead.")
ManeuverNotificationOptions.withAllFields(
  1. LanguageCode language,
  2. UnitSystem unitSystem,
  3. List<ManeuverNotificationType> includedNotificationTypes,
  4. bool enableRoundaboutNotification,
  5. bool enableDestinationReachedNotification,
  6. bool enableDoubleNotification,
  7. bool enablePhoneme,
  8. bool enableHighwayExit,
)

Creates a new instance of this class with full specified configurations.

  • language The language in which the notifications will be generated. When the specified language is not supported, the default language is used, which is English (American).
  • unitSystem Defines the measurement system used for distances. Defaults to metric.
  • includedNotificationTypes List of ManeuverNotificationType for which notifications should be generated. Excluding all of them will disable the maneuver notifications completely. By default, all types are included.
  • enableRoundaboutNotification A flag that indicates whether notification for roundabout-related maneuvers should be generated. Defaults to true.
  • enableDestinationReachedNotification A flag that indicates whether notification for destination/stopover reached maneuvers should be generated. Defaults to true.
  • enableDoubleNotification A flag that indicates whether combined maneuver notifications should be generated. Such double notifications can be useful when maneuvers are very close. Example: A combined message: 'After 300 meters turn left and then turn right.'. This way a user can better anticipate the next-next maneuver. Note that setting to true will make the notification longer as two maneuvers will be merged into one. When the next-next maneuver action takes place, the notification will be given as usual. Example: 'Now turn left and then then turn right.' will be followed by 'Now turn right.'. Defaults to true.
  • enablePhoneme A flag that indicates whether phonemes in selected notification format for proper nouns (e.g. road names, road numbers, city names) should be used when generating notifications. Direction information comes usually in orthographic form and phoneme (e.g. Wall Street and "wɔːl"striːt). However, when the notification is synthesized by a TTS engine, the pronunciation of the orthographic form solely depends on its capability and phoneme set. The use of our phoneme data in the notification usually makes the pronunciation of direction information sound more natural. Note: For now, this property is functional for road name and road number information only.

Defaults to false.

  • enableHighwayExit A flag that indicates whether highway exit information should be used when generating notification. Defaults to true.

Implementation

@Deprecated("Will be removed in v4.23.0. Use the `withDefaults` instead.")
ManeuverNotificationOptions.withAllFields(this.language, this.unitSystem, this.includedNotificationTypes, this.enableRoundaboutNotification, this.enableDestinationReachedNotification, this.enableDoubleNotification, this.enablePhoneme, this.enableHighwayExit)
    : arrivalNotificationOption = ArrivalNotificationOption.both, notificationFormatOption = NotificationFormatOption.plain, textUsageOptions = TextUsageOptions(), enableLaneRecommendation = false, includedNaturalGuidanceTypes = [], directionInformationUsageForActionNotificationOption = DirectionInformationUsageOption.none;