SchoolZoneWarningOptions

public struct SchoolZoneWarningOptions : Hashable

School zone warning options. Set the options to schoolZoneWarningOptions for configuring of school zone notifications.

  • If set to true, all the school zone notifications which have a time restrictions that does not apply for the current time will not be given. If the value is false, all school zone notifications will be given regardless of the time restrictions that they might have.

    Declaration

    Swift

    public var filterOutInactiveTimeDependentWarnings: Bool

  • The warning notification distance in meters applicable for school warning regardless of the timing profile. Defaults to 100 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 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.

    Declaration

    Swift

    public var warningDistanceInMeters: Int32

  • Creates a new instance.

    Declaration

    Swift

    public init(filterOutInactiveTimeDependentWarnings: Bool = false, warningDistanceInMeters: Int32 = 100)