com.tomtom.sdk.location:model/com.tomtom.sdk.location/Address

Address

data class Address(val streetNumber: String = "", val streetName: String = "", val municipalitySubdivision: String = "", val municipality: String = "", val countrySecondarySubdivision: String = "", val countryTertiarySubdivision: String = "", val countrySubdivision: String = "", val postalCode: String = "", val extendedPostalCode: String = "", val countryCode: String = "", val country: String = "", val countryCodeIso3: String = "", val freeformAddress: String = "", val countrySubdivisionName: String = "", val localName: String = "", val streetNameAndNumber: String = "", val postalName: String = "", val countrySubdivisionCode: String = "", val neighborhoodName: String = "")

Detailed address information.

Throws

IllegalArgumentException

if all the properties are empty.

Constructors

Address

constructor(streetNumber: String = "", streetName: String = "", municipalitySubdivision: String = "", municipality: String = "", countrySecondarySubdivision: String = "", countryTertiarySubdivision: String = "", countrySubdivision: String = "", postalCode: String = "", extendedPostalCode: String = "", countryCode: String = "", country: String = "", countryCodeIso3: String = "", freeformAddress: String = "", countrySubdivisionName: String = "", localName: String = "", streetNameAndNumber: String = "", postalName: String = "", countrySubdivisionCode: String = "", neighborhoodName: String = "")

Properties

country

val country: String

The name of the country.

countryCode

val countryCode: String

The ISO 3166-1 alpha-2 standard country code. For example: "US". See https://www.iso.org/obp/ui/#iso:std:iso:3166:-1:ed-4:v1:en for more details.

countryCodeIso3

val countryCodeIso3: String

The ISO 3166-1 alpha-3 standard country code. For example: "USA". See https://www.iso.org/obp/ui/#iso:std:iso:3166:-1:ed-4:v1:en for more details.

countrySecondarySubdivision

val countrySecondarySubdivision: String

The second-level administrative division. For example: a department in France, such as Pas-de-Calais in region Hauts-de-France.

countrySubdivision

val countrySubdivision: String

The first-level administrative division. For example: a region in France, such as Hauts-de-France.

countrySubdivisionCode

val countrySubdivisionCode: String

A code for the first-level subdivision of a country that is used alongside the countryCode to form the ISO 3166-2 code of the subdivision.The format of the ISO 3166-2 code is countryCode-countrySubdivisionCode. For example: "ON" (ISO 3166-2: "CA-ON") for Ontario, "TX" (ISO 3166-2: "US-TX") for Texas or "ZE" (ISO 3166-2: "NL-ZE") for Zeeland.

countrySubdivisionName

val countrySubdivisionName: String

The full name of the first-level administrative division of a country if countrySubdivision contains an abbreviation of the name, or empty otherwise. Supported only for the USA, Canada and the UK.

countryTertiarySubdivision

val countryTertiarySubdivision: String

The third-level administrative division. For example: an arrondissement in France, such as Calais in department Pas-de-Calais.

extendedPostalCode

val extendedPostalCode: String

The extended postal code (availability dependent on region).

freeformAddress

val freeformAddress: String

The freeform address. It represents the full address in a free text form.

localName

val localName: String

The local name. It represents an address component that contains the name of a geographical area that groups a number of addressable objects for addressing purposes, without being an administrative unit.

municipality

val municipality: String

The city/town.

municipalitySubdivision

val municipalitySubdivision: String

The city district. For example: Zuidoost in Amsterdam.

neighborhoodName

val neighborhoodName: String

The name of the neighborhood. Neighborhoods often have a semi-official status and are not necessarily part of an administrative structure. They are defined on a cultural, social or economic basis. For example, a neighborhood could be an area with touristic appeal, such as a restaurant area with a specific atmosphere. In general, neighborhoods don't have official borders or an equivalent in administrative or postal sources. Names of neighborhoods are commonly known and often used as place names. Examples: Karolinenviertel in Hamburg, Little Italy in New York, Quartier Pigalle in Paris, Soho in London, Museum Island in Berlin.

postalCode

val postalCode: String

The postal code.

postalName

val postalName: String

The postal name. It represents an address component that contains the postal code related to a single administrative area, city, town, or another populated place.

streetName

val streetName: String

The name of the street.

streetNameAndNumber

val streetNameAndNumber: String

The street name and number combined in the correct order.

streetNumber

val streetNumber: String

The number of the building.