WarningsRegistry

public class WarningsRegistry
extension WarningsRegistry: NativeBase
extension WarningsRegistry: Hashable

A class that store warning metadata for different warning types. Aggregates individual collection for each warning category (safety cameras, truck restrictions, etc.). Provided by WarnerEngine so callers can lookup detailed information about specific warnings.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

  • Returns a safety-camera warning corresponding to the given identifier.

    Declaration

    Swift

    public func getSafetyCameraWarning(warning: Warning) -> SafetyCameraWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single safety-camera warning within this registry and is used to retrieve its full metadata.

    Return Value

    The SafetyCameraWarning object associated with the provided WarningsRegistry.getSafetyCameraWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getSafetyCameraWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a truck restrictions warning corresponding to the given identifier.

    Declaration

    Swift

    public func getTruckRestrictionWarning(warning: Warning) -> TruckRestrictionWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single truck restrictions warning within this registry and is used to retrieve its full metadata.

    Return Value

    The TruckRestrictionWarning object associated with the provided WarningsRegistry.getTruckRestrictionWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getTruckRestrictionWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a road-sign warning corresponding to the given identifier.

    Declaration

    Swift

    public func getRoadSignWarning(warning: Warning) -> RoadSignWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single road sign warning within this registry and is used to retrieve its full metadata.

    Return Value

    The sdk.navigation.RoadSignWarning object associated with the provided WarningsRegistry.getRoadSignWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getRoadSignWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a realistic-view warning corresponding to the given identifier.

    Declaration

    Swift

    public func getRealisticViewWarning(warning: Warning) -> RealisticViewWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single realistic-view warning within this registry and is used to retrieve its full metadata.

    Return Value

    The RealisticViewWarning object associated with the provided WarningsRegistry.getRealisticViewWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getRealisticViewWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns environmental zone warning corresponding to the given identifier.

    Declaration

    Swift

    public func getEnvironmentalZoneWarning(warning: Warning) -> EnvironmentalZoneWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single environmental zone warning within this registry and is used to retrieve its full metadata.

    Return Value

    The EnvironmentalZoneWarning object associated with the provided WarningsRegistry.getEnvironmentalZoneWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getEnvironmentalZoneWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a school zone warning corresponding to the given identifier.

    Declaration

    Swift

    public func getSchoolZoneWarning(warning: Warning) -> SchoolZoneWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single school zone warning within this registry and is used to retrieve its full metadata.

    Return Value

    The SchoolZoneWarning object associated with the provided WarningsRegistry.getSchoolZoneWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getSchoolZoneWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a toll stop warning corresponding to the given identifier.

    Declaration

    Swift

    public func getTollStopWarning(warning: Warning) -> TollStop?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single toll stop warning within this registry and is used to retrieve its full metadata.

    Return Value

    The TollStop object associated with the provided WarningsRegistry.getTollStopWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getTollStopWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a danger zone warning corresponding to the given identifier.

    Declaration

    Swift

    public func getDangerZoneWarning(warning: Warning) -> DangerZoneWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single danger zone warning within this registry and is used to retrieve its full metadata.

    Return Value

    The DangerZoneWarning object associated with the provided WarningsRegistry.getDangerZoneWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getDangerZoneWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a border crossing warning corresponding to the given identifier.

    Declaration

    Swift

    public func getBorderCrossingWarning(warning: Warning) -> BorderCrossingWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single border crossing warning within this registry and is used to retrieve its full metadata.

    Return Value

    The BorderCrossingWarning object associated with the provided WarningsRegistry.getBorderCrossingWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getBorderCrossingWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a railway crossing warning corresponding to the given identifier.

    Declaration

    Swift

    public func getRailwayCrossingWarning(warning: Warning) -> RailwayCrossingWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single railway crossing warning within this registry and is used to retrieve its full metadata.

    Return Value

    The RailwayCrossingWarning object associated with the provided WarningsRegistry.getRailwayCrossingWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getRailwayCrossingWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a low speed zone warning corresponding to the given identifier.

    Declaration

    Swift

    public func getLowSpeedZoneWarning(warning: Warning) -> LowSpeedZoneWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single low speed zone warning within this registry and is used to retrieve its full metadata.

    Return Value

    The LowSpeedZoneWarning object associated with the provided WarningsRegistry.getLowSpeedZoneWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getLowSpeedZoneWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a traffic merge warning corresponding to the given identifier.

    Declaration

    Swift

    public func getTrafficMergeWarning(warning: Warning) -> TrafficMergeWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single traffic merge warning within this registry and is used to retrieve its full metadata.

    Return Value

    The sdk.navigation.TrafficMergeWarning object associated with the provided WarningsRegistry.getTrafficMergeWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getTrafficMergeWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

  • Returns a lane decrease warning corresponding to the given identifier.

    Declaration

    Swift

    public func getLaneDecreaseWarning(warning: Warning) -> LaneDecreaseWarning?

    Parameters

    warning

    The identifier of the warning, as provided by WarningListener.onWarning. The warning uniquely identifies a single lane decrease warning within this registry and is used to retrieve its full metadata.

    Return Value

    The LaneDecreaseWarning object associated with the provided WarningsRegistry.getLaneDecreaseWarning(...).warning, or nil if no warning exists for the given WarningsRegistry.getLaneDecreaseWarning(...).warning. This object contains the full details and attributes of the corresponding warning.

    Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

  • Returns additional data associated with the given custom warning.

    The provided WarningsRegistry.getCustomWarning(...).warning identifies a specific custom warning instance by its base warning information and custom warning type. This information is used to resolve the corresponding entry in the warning registry and retrieve any additional, type-specific data associated with the warning.

    Declaration

    Swift

    public func getCustomWarning(warning: Warning) -> CustomWarning?

    Parameters

    warning

    The Warning instance identifying the custom warning for which additional data should be retrieved.

    Return Value

    The CustomWarning associated with the given WarningsRegistry.getCustomWarning(...).warning, or nil if no additional data exists for this warning. The returned object contains the payload with type-specific details and attributes of the corresponding warning.

    Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.