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

Package-level declarations

Types

ApiKeyFailure

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

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

ConnectionFailure

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

Hazards could not establish a connection to the Hazards service.

DeserializationFailure

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

Deserialization of a single Hazard has failed.

ExperimentalHazardsApi

annotation class ExperimentalHazardsApi

HazardCategory

@JvmInline

value class HazardCategory

Describes the categories of Hazard data.

HazardId

@JvmInline

value class HazardId(val value: String)

Identifies a hazard.

HazardLocation

abstract class HazardLocation

Represents a hazard location.

HazardSeverity

@JvmInline

value class HazardSeverity

Describes the level of severity.

HazardsFailure

abstract class HazardsFailure

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

HazardsOptions

class HazardsOptions(val boundingBoxes: List<GeoBoundingBox>, val types: List<HazardType> = HazardType.getAllHazardTypes())

A configuration that can be used in Hazards.

HazardType

@JvmInline

value class HazardType

Describes the type of Hazard data.

HttpFailure

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

Hazards call ended with unexpected HTTP code.

NetworkFailure

class NetworkFailure(val message: String) : HazardsFailure

Hazards call failed with IOException due to network problems.

SubscriptionFailure

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

Hazards could not complete a subscription request.

UnknownFailure

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

Hazards call ended with an unknown error.