Warning

public struct Warning : Hashable

A struct which represents a 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.

  • id

    Identifier of the warning. The ID is unique only within its specific warningType and can be used to retrieve additional information from a corresponding registry.

    Declaration

    Swift

    public var id: Int32

  • The type of distance measurement used for this warning.

    Declaration

    Swift

    public var distanceType: DistanceType

  • The specific type of the warning.

    Declaration

    Swift

    public var warningType: WarningType

  • Identifier of the custom warning type.

    Defines the category of the custom warning and determines which warning registry should be used to retrieve additional warning details. This field is set only when warningType == WarningType.CUSTOM and is nil for all other warning types.

    Declaration

    Swift

    public var customWarningType: Int32?

  • Creates a new instance.

    • Parameters

      • id: Identifier of the warning. The ID is unique only within its specific warningType and can be used to retrieve additional information from a corresponding registry.
      • distanceType: The type of distance measurement used for this warning.
      • warningType: The specific type of the warning.
      • customWarningType: Identifier of the custom warning type.

      Defines the category of the custom warning and determines which warning registry should be used to retrieve additional warning details. This field is set only when warningType == WarningType.CUSTOM and is nil for all other warning types.

    Declaration

    Swift

    public init(id: Int32, distanceType: DistanceType, warningType: WarningType, customWarningType: Int32? = nil)