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

Package-level declarations

Types

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.

DetailedHazardInformation

abstract class DetailedHazardInformation

Describes the detailed Hazard information.

data class Hazard(val id: HazardId, val expirationTime: Date, val type: HazardType, val category: HazardCategory, val severity: HazardSeverity, val detailedInformation: DetailedHazardInformation?, val location: HazardLocation, val version: Int, val openLocationReference: OpenLocationReference?)

A hazard entry.

value class HazardCategory

Describes the categories of Hazard data.

value class HazardId(val value: String)

Identifies a hazard.

abstract class HazardLocation

Represents a hazard location.

class Hazards constructor(hazardsProvider: MqttDataProvider, postDispatcher: CoroutineDispatcher = Dispatchers.Main, backgroundDispatcher: CoroutineDispatcher = Dispatchers.IO.limitedParallelism( NUMBER_OF_PARALLEL_DESERIALIZATIONS )) : AutoCloseable

Identifies hazards provider.

value class HazardSeverity

Describes the level of severity.

object HazardsFactory

Factory to create a Hazards that provides Hazard updates.

abstract class HazardsFailure(val message: String)

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

HazardsListener

interface HazardsListener

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

data class HazardsOptions(val mortonTile: MortonTile, val types: List<HazardType> = emptyList())

A configuration that can be used in Hazards.

value class HazardType

Describes the type of Hazard data.

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

Hazards call ended with unexpected HTTP code.

class NetworkFailure(val message: String) : HazardsFailure

Hazards call failed with IOException due to network problems.

OpenLocationReference

value class OpenLocationReference(val value: String)

Map-agnostic location reference generated out of map-dependent location.

SubscriptionFailure

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

Hazards could not complete a subscription request.

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

Hazards call ended with an unknown error.

Properties

API_KEY_ERROR_MESSAGE

const val API_KEY_ERROR_MESSAGE: String

CONNECTION_FAILURE_DEFAULT_MESSAGE

const val CONNECTION_FAILURE_DEFAULT_MESSAGE: String

DESERIALIZATION_FAILURE_DEFAULT_MESSAGE

const val DESERIALIZATION_FAILURE_DEFAULT_MESSAGE: String

SUBSCRIPTION_FAILURE_DEFAULT_MESSAGE

const val SUBSCRIPTION_FAILURE_DEFAULT_MESSAGE: String

UNKNOWN_FAILURE_DEFAULT_MESSAGE

const val UNKNOWN_FAILURE_DEFAULT_MESSAGE: String