platform_navigation_api_common_model/com.tomtom.ivi.platform.navigation.api.common.model

Package-level declarations

Types

data class Address(val country: String? = null, val countryId: CountryId? = null, val state: String? = null, val stateCode: String? = null, val city: String? = null, val cityDistrict: String? = null, val cityBlock: String? = null, val houseNumber: String? = null, val streetName: String? = null, val buildingName: String? = null, val floor: String? = null, val door: String? = null, val postalCode: String? = null, val extendedPostalCode: String? = null, val formattedAddress: String? = null) : Parcelable

Class to hold information about an address.

Coordinate

class Coordinate(val latitude: Angle, val longitude: Angle, val altitude: Distance = Distance.meters(0)) : Parcelable

A class to hold a coordinate to express a location in latitude, longitude and altitude.

Place

class Place(val coordinate: Coordinate, val name: String? = null, val address: Address? = null) : Parcelable

A class to represent a place on the map.

TripId

class TripId(val id: String) : Parcelable

An ID to uniquely identify a trip. Typically an API would use a TripId as a way to expose a trip. Therefore, there should be a mechanism that can encode/decode a trip to/from a TripId.

TripPlan

class TripPlan(val departure: Coordinate?, val destination: Coordinate) : Parcelable

A class representing a request to plan a trip from departure to destination. If departure is null, the last known position is used as departure when planning a trip.

TripPlanError

class TripPlanError(val errorType: TripPlanErrorType, val message: String?) : Parcelable

A class to hold information related to a trip planning error. The errorType will give a general indication of the reason the trip planning failed. If available, message will contain a detailed error messages, describing the trip planning failure; otherwise will be null.

TripPlanErrorType

enum TripPlanErrorType : Enum<TripPlanErrorType> , Parcelable

The reason a trip planning failed.