TrafficIncident

public struct TrafficIncident : Decodable

Represents traffic incident details.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • Declaration

    Swift

    public init(from decoder: Decoder) throws

Public

  • The delay caused by the incident in seconds (except in road closures). It is calculated against free-flow travel time (the travel time when the traffic is minimal, e.g., night traffic).

    Declaration

    Swift

    public let delay: Int
  • The magnitude of delay associated with the incident.

    Declaration

    Swift

    public let magnitude: TrafficMagnitude
  • The property presence indicates the incident is clustered. The value of the clustered tag is equal to the ID of the parent cluster.

    Declaration

    Swift

    public let clustered: Int?
  • ID of the cluster. The property presence indicates that the feature is a cluster of POIs.

    Declaration

    Swift

    public let clusterId: Int?
  • The number of incidents within a cluster. The property presence indicates that the feature is a cluster of POIs.

    Declaration

    Swift

    public let clusterSize: Int?
  • One of the Community Attributes (ACI). Number of reports given by actual end-users.

    Declaration

    Swift

    public let numberOfReports: Int?
  • Describes the road type. @Discussion: Allowed values:

    • Motorway
    • International road
    • Major road
    • Secondary road
    • Connecting road
    • Major local road
    • Local road
    • Minor local road Non public road Parking road

    Declaration

    Swift

    public let roadType: String?
  • The tag value describes if the traffic is assigned to the whole road (one way road), or only to one side (two-way road). @Discussion: Allowed values:

    • one_side
    • full

    Declaration

    Swift

    public let trafficRoadCoverage: String?
  • The beginning of incidents is described as start_poi. If the traffic incident has no geometry, it is described as standalone_poi. @Discussion: Allowed values:

    • start_poi
    • standalone_poi

    Declaration

    Swift

    public let poiType: String?
  • One of the Community Attributes (ACI). Enumeration string specifying the likelihood of the occurring incident. @Discussion: Allowed values:

    • certain
    • probable
    • risk_of
    • improbable

    Declaration

    Swift

    public let probabilityOfOccurrence: String?
  • The tag value describes if the traffic is assigned to the whole road (one way road), or only to one side (two-way road). @Discussion: Allowed value:

    • one_side
    • full

    Declaration

    Swift

    public let leftHandTraffic: Bool?
  • Estimated end date of the incident, when available.

    Declaration

    Swift

    public let endDate: Date?
  • One of the Community Attributes (ACI). The date when the last time the incident was reported.

    Declaration

    Swift

    public let lastReportTime: Date?
  • The icon categories associated with this incident.

    If all incidents in the cluster belong to the same type, it will return the incident’s type icon. Otherwise, it will return the cluster icon.

    Declaration

    Swift

    public let iconCategories: [TrafficIconCategory]
  • A description of the incident with the corresponding iconCategories

    Declaration

    Swift

    public let descriptions: [String]