com.tomtom.sdk.vehicle:vehicle-metadata-provider/com.tomtom.sdk.vehicle.metadata

Package-level declarations

Types

class BodyProperties

Represents the body properties of a vehicle.

value class BodyType

Value class representing the body type of a vehicle.

class Brand

Represents a vehicle brand.

value class BrandId(val value: UUID)

A value class representing a unique identifier for a brand.

class BrandOptions(val engineType: EngineType? = null, val vehicleType: VehicleType? = null)

Options for requesting vehicle brands.

class BrandsResponse

Response class containing brands.

sealed class CacheDirectory

Configuration for where to cache vehicle details for offline usage.

value class DriveTrain

Value class representing the drive train of a vehicle.

ElectricVehicleProperties

class ElectricVehicleProperties

Represents the properties of an electric vehicle.

value class EngineType

Value class representing the engine type of a vehicle.

class Model

Represents a vehicle model.

value class ModelId(val value: UUID)

A value class representing a unique identifier for a model.

class ModelOptions(val engineType: EngineType? = null, val vehicleType: VehicleType? = null, val brandId: BrandId? = null)

Options for requesting vehicle models.

class ModelsResponse

Response class containing models.

data class PlugType

Represents a charging plug type for a vehicle.

ProductionStatus

value class ProductionStatus

Value class representing the production status of a vehicle.

RetrieveVehicleOptions

class RetrieveVehicleOptions

Options for retrieving a vehicle based on its VehicleMetadataId.

VehicleMetadata

class VehicleMetadata

Represents metadata for a vehicle.

VehicleMetadataByIdOptions

class VehicleMetadataByIdOptions(val id: VehicleMetadataId)

Options for requesting vehicle metadata by its unique identifier.

VehicleMetadataByIdResponse

class VehicleMetadataByIdResponse

Response class containing vehicle metadata retrieved by its unique identifier.

VehicleMetadataFailure

abstract class VehicleMetadataFailure

Represents a failure related to a vehicle metadata request.

VehicleMetadataId

value class VehicleMetadataId(val value: UUID)

A value class representing a unique identifier for vehicle metadata.

VehicleMetadataOptions

class VehicleMetadataOptions(val engineType: EngineType? = null, val vehicleType: VehicleType? = null, val brandId: BrandId? = null, val modelId: ModelId? = null)

Options for requesting vehicle metadata.

VehicleMetadataProvider

interface VehicleMetadataProvider : AutoCloseable

Entry point for retrieving vehicle metadata.

VehicleMetadataResponse

class VehicleMetadataResponse

Response class containing vehicle metadata.

Properties

DEFAULT_API_URI

val DEFAULT_API_URI: Uri

The default Uri for the vehicle metadata API. This Uri is used for requests when no specific API Uri is provided.

Functions

buildRetrieveElectricVehicleOptions

fun buildRetrieveElectricVehicleOptions(id: VehicleMetadataId, chargeLevel: ChargeLevel, vehicleType: VehicleType): RetrieveVehicleOptions

Builds RetrieveVehicleOptions for an electric vehicle.

VehicleMetadataProvider

fun VehicleMetadataProvider(context: Context, apiKey: String): VehicleMetadataProvider

Creates an instance of VehicleMetadataProvider using the provided context and API key.

fun VehicleMetadataProvider(context: Context, apiKey: String, apiUri: Uri): VehicleMetadataProvider

Creates an instance of VehicleMetadataProvider using the provided context, API key, and API URI.

fun VehicleMetadataProvider(context: Context, apiKey: String, apiUri: Uri = DEFAULT_API_URI, cacheDirectory: CacheDirectory = CacheDirectory.DefaultDirectory): VehicleMetadataProvider

Creates an instance of VehicleMetadataProvider using the provided context, API key, optional API Uri, and optional caching directory for storing vehicle details.