Package com.here.sdk.navigation

Class ManeuverNotificationOptions

java.lang.Object
com.here.sdk.navigation.ManeuverNotificationOptions
public final class ManeuverNotificationOptions extends Object

A class containing all options to be used when generating maneuver notifications.

  • Field Details

    • language

      @NonNull public LanguageCode 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

      @NonNull public UnitSystem unitSystem

      Defines the measurement system used for distances. Defaults to metric.

    • includedNotificationTypes

      @NonNull public List<ManeuverNotificationType> 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

      public boolean enableRoundaboutNotification

      A flag that indicates whether notification for roundabout-related maneuvers should be generated. Defaults to true.

    • enableDestinationReachedNotification

      @Deprecated public boolean enableDestinationReachedNotification
      Deprecated.

      Will be removed in v4.27.0. Use the arrivalNotificationOption instead

      A flag that indicates whether notification for destination/stopover reached maneuvers should be generated. Defaults to true.

    • arrivalNotificationOption

      @NonNull public ArrivalNotificationOption arrivalNotificationOption

      A flag that indicates whether notification for destination and/or stopover reached maneuvers should be generated. Defaults to ArrivalNotificationOption.BOTH.

    • enableDoubleNotification

      public boolean 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

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

    • notificationFormatOption

      @NonNull public NotificationFormatOption notificationFormatOption

      A formatting option for the phoneme that is included in the notification. By default, no phoneme is used and the NotificationFormatOption.PLAIN orthographic form is included in the notification.

      Note: To use the SSML format for phonemes, enablePhoneme needs to be set to true.

    • textUsageOptions

      @NonNull public TextUsageOptions textUsageOptions

      An option whether street name, road number and sign post direction should be used when generating notification. Defaults to each attribute as LocalizedTextPreference.USE_ALWAYS.

    • enableHighwayExit

      public boolean enableHighwayExit

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

    • enableLaneRecommendation

      public boolean enableLaneRecommendation

      A flag that indicates whether lane recommendation should be used when generating notifications. In case the flag is enabled, only the notification for the ManeuverNotificationType.DISTANCE maneuver notification type will contain the lane recommendation. The lane recommandation will replace the direction information in the notification. Example: 'After 250 meters use the right two lanes and turn right.'. Defaults to false.

    • includedNaturalGuidanceTypes

      @NonNull public List<NaturalGuidanceType> includedNaturalGuidanceTypes

      List of NaturalGuidanceType should be included in the notifications. Excluding all of them will disable natural guidance information in the notifications completely.

      By default, the list is empty and natural guidance is disabled.

    • directionInformationUsageForActionNotificationOption

      @NonNull public DirectionInformationUsageOption directionInformationUsageForActionNotificationOption

      An option whether direction information should be used when generating notification with ManeuverNotificationType.ACTION. Defaults to DirectionInformationUsageOption.NONE.

  • Constructor Details

    • ManeuverNotificationOptions

      public ManeuverNotificationOptions()

      Creates a new instance of this class with default configurations.

    • ManeuverNotificationOptions

      @Deprecated public ManeuverNotificationOptions(@NonNull LanguageCode language, @NonNull UnitSystem unitSystem)
      Deprecated.

      Will be removed in v4.23.0. Use the default constructor instead.

      Creates a new instance of this class with specified language and unit system.

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

    • ManeuverNotificationOptions

      @Deprecated public ManeuverNotificationOptions(@NonNull LanguageCode language, @NonNull UnitSystem unitSystem, @NonNull List<ManeuverNotificationType> includedNotificationTypes, boolean enableRoundaboutNotification, @Deprecated boolean enableDestinationReachedNotification, boolean enableDoubleNotification, boolean enablePhoneme, @NonNull TextUsageOptions textUsageOptions, boolean enableHighwayExit)
      Deprecated.

      Will be removed in v4.23.0. Use the default constructor instead.

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

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

      textUsageOptions -

      An option whether street name, road number and sign post direction should be used when generating notification. Defaults to each attribute as LocalizedTextPreference.USE_ALWAYS.

      enableHighwayExit -

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

    • ManeuverNotificationOptions

      @Deprecated public ManeuverNotificationOptions(@NonNull LanguageCode language, @NonNull UnitSystem unitSystem, @NonNull List<ManeuverNotificationType> includedNotificationTypes, boolean enableRoundaboutNotification, @Deprecated boolean enableDestinationReachedNotification, boolean enableDoubleNotification, boolean enablePhoneme, boolean enableHighwayExit)
      Deprecated.

      Will be removed in v4.23.0. Use the default constructor instead.

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

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

    • ManeuverNotificationOptions

      @Deprecated public ManeuverNotificationOptions(@NonNull LanguageCode language, @NonNull UnitSystem unitSystem, @NonNull List<ManeuverNotificationType> includedNotificationTypes, boolean enableRoundaboutNotification, @Deprecated boolean enableDestinationReachedNotification, boolean enableDoubleNotification, boolean enablePhoneme, @NonNull NotificationFormatOption notificationFormatOption, boolean enableHighwayExit)
      Deprecated.

      Will be removed in v4.23.0. Use the default constructor instead.

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

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

      notificationFormatOption -

      A formatting option for the phoneme that is included in the notification. By default, no phoneme is used and the NotificationFormatOption.PLAIN orthographic form is included in the notification.

      Note: To use the SSML format for phonemes, enablePhoneme needs to be set to true.

      enableHighwayExit -

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

  • Method Details