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

Package-level declarations

Types

ApiKeyFailure

class ApiKeyFailure(val message: String = API_KEY_ERROR_MESSAGE) : SafetyLocationsFailure

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

ConnectionFailure

class ConnectionFailure(val message: String? = null) : SafetyLocationsFailure

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

DeserializationFailure

class DeserializationFailure(val message: String? = null) : SafetyLocationsFailure

Deserialization of a single safety location has failed.

EncodedSafetyLocation

class EncodedSafetyLocation(val safetyLocation: SafetyLocation, val openLocationReference: String)

Describes a safety location. It contains a SafetyLocation and its location reference on the map.

HttpFailure

class HttpFailure(val httpErrorCode: Int, val message: String) : SafetyLocationsFailure

Safety Locations call ended with unexpected HTTP code.

NetworkFailure

class NetworkFailure(val message: String) : SafetyLocationsFailure

Safety Locations call failed with IOException due to network problems.

SafetyLocations

interface SafetyLocations : AutoCloseable

Interface to safety location providers. To obtain safety location data, a client must first subscribe by registering safety location options, then call function provide to fetch data according to those options.

SafetyLocationsFailure

abstract class SafetyLocationsFailure

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

SafetyLocationsOptions

class SafetyLocationsOptions(val boundingBoxes: List<GeoBoundingBox>, val types: List<SafetyLocationType> = SafetyLocationType.getAllSafetyLocationTypes())

Configuration options that can be used to subscribe to, unsubscribe from and provide safety locations. The options specify the rectangular areas of interest as well as the safety location types of interest for these areas.

SafetyLocationsUpdateListener

interface SafetyLocationsUpdateListener

Interface to listeners for safety location updates. The listener will be executed on the main thread.

SubscriptionFailure

class SubscriptionFailure(val message: String? = null) : SafetyLocationsFailure

Safety Locations could not complete a subscription request.

UnknownFailure

class UnknownFailure(val message: String? = null) : SafetyLocationsFailure

Safety Locations call ended with an unknown error.