TrafficMergeWarningOptions

public struct TrafficMergeWarningOptions : Hashable

Traffic merge warning options. Set the options to trafficMergeWarningOptions for filtering the traffic merge notifications.

  • The types of roads containing traffic which will trigger a warning when they merge with the current highway. If the list is empty, the merging roads containing traffic are not filtered by type.

    Declaration

    Swift

    public var typesFilter: [TrafficMergeRoadType]
  • Enables or disables the text notification emitted together with the traffic merge warner. Note: In order to receive the text notification emitted for the traffic merge warner, when [TrafficMergeWarningOptions.enable_text_notification] has been enabled, the EventTextDelegate must be enabled as well.

    Declaration

    Swift

    public var enableTextNotification: Bool
  • The warning notification distance in meters applicable for traffic merge warning regardless of the timing profile. Defaults to 1500 meters. Note: For most warners, the warning notification distances are set using [NavigatorInterface.set_warning_notification_distances] method from NavigatorProtocol. However 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.

    Declaration

    Swift

    public var warningDistanceInMeters: Int32
  • Creates a new instance.

    Declaration

    Swift

    public init(typesFilter: [TrafficMergeRoadType] = [], enableTextNotification: Bool = true, warningDistanceInMeters: Int32 = 1500)