maplibre-navigation-core/org.maplibre.navigation.core.models/Incident

Incident

@Serializable

data class Incident(val id: String, val type: Incident.Type? = null, val closed: Boolean? = null, val congestion: Congestion? = null, val description: String? = null, val longDescription: String? = null, val impact: Incident.Impact? = null, val subType: String? = null, val subTypeDescription: String? = null, val alertcCodes: List<Int>? = null, val geometryIndexStart: Int? = null, val geometryIndexEnd: Int? = null, val creationTime: String? = null, val startTime: String? = null, val endTime: String? = null)

Reproduces one of road incidents type (Type) that might be on the way.

Constructors

Incident

constructor(id: String, type: Incident.Type? = null, closed: Boolean? = null, congestion: Congestion? = null, description: String? = null, longDescription: String? = null, impact: Incident.Impact? = null, subType: String? = null, subTypeDescription: String? = null, alertcCodes: List<Int>? = null, geometryIndexStart: Int? = null, geometryIndexEnd: Int? = null, creationTime: String? = null, startTime: String? = null, endTime: String? = null)

Types

Builder

class Builder(id: String)

Builder class for creating Incident instances.

Impact

@Serializable

enum Impact : Enum<Incident.Impact>

Type

@Serializable

enum Type : Enum<Incident.Type>

Properties

alertcCodes

@SerialName(value = "alertc_codes")

val alertcCodes: List<Int>? = null

AlertC codes.

closed

val closed: Boolean? = null

True if road is closed and no possibility to pass through there. False otherwise.

congestion

val congestion: Congestion? = null

Quantitative descriptor of congestion.

creationTime

@SerialName(value = "creation_time")

val creationTime: String? = null

Time the incident was created/updated in ISO8601 format. Not the same .startTime/.endTime, incident can be created/updated before the incident.

description

val description: String? = null

Human-readable description of the incident suitable for displaying to the users.

endTime

@SerialName(value = "end_time")

val endTime: String? = null

End time of the incident in ISO8601 format.

geometryIndexEnd

@SerialName(value = "geometry_index_end")

val geometryIndexEnd: Int? = null

Incident's geometry index end point.

geometryIndexStart

@SerialName(value = "geometry_index_start")

val geometryIndexStart: Int? = null

Incident's geometry index start point.

val id: String

Unique identifier for incident. It might be the only one non-null filed which meant that incident started on previous leg and one has an incident with the same id.

impact

val impact: Incident.Impact? = null

Severity level of incident.

longDescription