RoadSignWarningOptions

public struct RoadSignWarningOptions : Hashable

A struct that provides road sign warning options. Set the options for filtering of road sign notifications.

  • The list of road sign types for which a warning will be given. If the list is empty, road signs are not filtered by type.

    Declaration

    Swift

    public var typesFilter: [RoadSignType]

  • The list of road sign categories for which a warning will be given. If the list is empty, road signs are not filtered by category.

    Declaration

    Swift

    public var categoriesFilter: [RoadSignCategory]

  • The list of road sign general warning types for which a warning will be given. If the list is empty, road signs are not filtered by general warning type.

    Declaration

    Swift

    public var generalWarningTypesFilter: [GeneralWarningRoadSignType]

  • The list of road sign vehicle types for which a warning will be given. If the list is empty, road signs are not filtered by vehicle type, which means that you get road sign warnings for all vehicle types.

    Example: For a filter that contains only bus and trucks you will only receive specific road sign warnings for bus and trucks - you will not get signs for the other types, such as heavy trucks or motorhomes. Furthermore, you will not get any signs that are generally applicable for all vehicles. For example, you cannot set a filter that allows to get signs for trucks and cars. If you want to get signs for standard vehicles like cars, then the only option is to set an empty list as filter.

    Declaration

    Swift

    public var vehicleTypesFilter: [RoadSignVehicleType]

  • Creates a new instance.

    • Parameters

      • typesFilter: The list of road sign types for which a warning will be given. If the list is empty, road signs are not filtered by type.
      • categoriesFilter: The list of road sign categories for which a warning will be given. If the list is empty, road signs are not filtered by category.
      • generalWarningTypesFilter: The list of road sign general warning types for which a warning will be given. If the list is empty, road signs are not filtered by general warning type.
      • vehicleTypesFilter: The list of road sign vehicle types for which a warning will be given. If the list is empty, road signs are not filtered by vehicle type, which means that you get road sign warnings for all vehicle types.

      Example: For a filter that contains only bus and trucks you will only receive specific road sign warnings for bus and trucks - you will not get signs for the other types, such as heavy trucks or motorhomes. Furthermore, you will not get any signs that are generally applicable for all vehicles. For example, you cannot set a filter that allows to get signs for trucks and cars. If you want to get signs for standard vehicles like cars, then the only option is to set an empty list as filter.

    Declaration

    Swift

    public init(typesFilter: [RoadSignType] = [], categoriesFilter: [RoadSignCategory] = [], generalWarningTypesFilter: [GeneralWarningRoadSignType] = [], vehicleTypesFilter: [RoadSignVehicleType] = [])