com.tomtom.sdk.safetylocations:safetylocations-online/com.tomtom.sdk.safetylocations.online

Package-level declarations

Types

Link copied to clipboard
class ApiKeyFailure(val message: String = API_KEY_ERROR_MESSAGE) : SafetyLocationsFailure

Safety Locations call did not finish due to a problem with the API key.

Link copied to clipboard
class ConnectionFailure(val message: String? = null) : SafetyLocationsFailure

Safety Locations could not establish a connection to the Safety Locations service.

Link copied to clipboard
class DeserializationFailure(val message: String? = null) : SafetyLocationsFailure

Deserialization of a single SafetyLocation has failed.

Link copied to clipboard
class HttpFailure(val httpErrorCode: Int, val message: String) : SafetyLocationsFailure

Safety Locations call ended with unexpected HTTP code.

Link copied to clipboard
class NetworkFailure(val message: String) : SafetyLocationsFailure

Safety Locations call failed with IOException due to network problems.

Link copied to clipboard
data class SafetyCameraSpot(val id: SafetyLocationId, val time: Date, val openLocationReference: String, val speedLimit: Speed?, val position: GeoLocation, val type: SafetyCameraSpotType) : SafetyLocation

Describes a safety camera spot at a given location.

Link copied to clipboard
@JvmInline
value class SafetyCameraSpotType(val value: Int)

Describes the specific purpose of a safety camera at a spot.

Link copied to clipboard
interface SafetyLocation

Describes a safety location.

Link copied to clipboard
@JvmInline
value class SafetyLocationId(val value: Int)

Identifies a safety location.

Link copied to clipboard
class SafetyLocations constructor(mqttDataProvider: MqttDataProvider, postDispatcher: CoroutineDispatcher = Dispatchers.Main, backgroundDispatcher: CoroutineDispatcher = Dispatchers.IO.limitedParallelism( NUMBER_OF_PARALLEL_DESERIALIZATIONS )) : AutoCloseable
Link copied to clipboard
object SafetyLocationsFactory

Factory to create a SafetyLocations that provides SafetyLocation updates.

Link copied to clipboard
abstract class SafetyLocationsFailure

Describes the error that happened during the processing of the subscription request.

Link copied to clipboard
interface SafetyLocationsListener

Listens for SafetyLocation updates. The callback will be executed on the main thread.

Link copied to clipboard
data class SafetyLocationsOptions(val mortonTile: MortonTile, val types: List<SafetyLocationType> = emptyList())

A configuration that can be used in SafetyLocations.

Link copied to clipboard
@JvmInline
value class SafetyLocationType(val value: String)

Describes the specific purpose of a safety camera at a spot.

Link copied to clipboard
class SubscriptionFailure(val message: String? = null) : SafetyLocationsFailure

Safety Locations could not complete a subscription request.

Link copied to clipboard
data class TrafficEnforcementZone(val id: SafetyLocationId, val time: Date, val openLocationReference: String, val speedLimit: Speed?, val positions: List<GeoLocation>, val type: TrafficEnforcementZoneType) : SafetyLocation

Describes a traffic enforcement zone.

Link copied to clipboard
@JvmInline
value class TrafficEnforcementZoneType(val value: Int)

Describes the specific purpose of a traffic enforcement zone.

Link copied to clipboard
class UnknownFailure(val message: String? = null) : SafetyLocationsFailure

Safety Locations call ended with an unknown error.