com.tomtom.sdk.traffic:traffic-common/com.tomtom.sdk.traffic

Package-level declarations

Includes the interface for the Traffic Data Provider, alongside associated communication status, response data classes, and the callback interface.

It also provides the traffic event representation TrafficEvent. Traffic events represent unusual situations on the road, like traffic congestion, accidents or road works.

Types

Category

@JvmInline

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

value class Category

Indicates the category to which a traffic event belongs.

Cause

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

data class Cause(var mainCause: CauseCode, var warningLevel: WarningLevel, var subCause: Int? = null)

Indicates the cause of a traffic event.

CauseCode

@JvmInline

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

value class CauseCode

Indicates the cause of the traffic event. Codes are chosen according to the TPEG-TEC standard.

EffectCode

@JvmInline

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

value class EffectCode

Indicates the effect the traffic event has on the traffic flow. Codes are chosen according to the TPEG-TEC standard.

RoadClass

@JvmInline

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

value class RoadClass

Indicates the class of a road.

RoadSubClass

@JvmInline

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

value class RoadSubClass

Indicates the subclass of a road.

RoadType

@JvmInline

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

value class RoadType

Indicates the type of a road.

Traffic

interface Traffic : AutoCloseable

This is the public interface for the Traffic Data Provider in NavSDK. This interface can be passed to other components in NavSDK that work with traffic data.

TrafficChangedListener

fun interface TrafficChangedListener

Used to inform the caller that the traffic situation has changed.

TrafficError

abstract class TrafficError

Represents an error raised when something went wrong in the Traffic SDK.

TrafficEvent

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

class TrafficEvent(var id: String, var category: Category? = null, var delay: Duration? = null, var length: Distance? = null, var path: List<GeoPoint> = emptyList(), var effectCode: EffectCode? = null, var isOneWay: Boolean, var drivingSide: DrivingSide, var causes: List<Cause> = emptyList(), var roadType: RoadType, var roadClass: RoadClass? = null, var roadSubclass: RoadSubClass? = null)

Representation of a traffic event. Traffic events represent unusual situations on the road, like traffic congestion, accidents or road works.

TrafficEventsCallback

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

interface TrafficEventsCallback : Callback<TrafficEventsResult, TrafficError>

Callback responsible for reporting when a TrafficEventsResult or corresponding TrafficError is received.

TrafficEventsResult

data class TrafficEventsResult(val trafficEvents: List<TrafficEvent>, val boundingBox: GeoBoundingBox)

Represents the result of a query to get traffic events in an area.

WarningLevel

@JvmInline

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

value class WarningLevel

Indicates the severity of the traffic event. Values are chosen according to the TPEG-TEC standard.