common:core/com.tomtom.sdk.common.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 = "")

Describes the detailed address.

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

streetNumber

The building's number.

streetName

The street name.

municipalitySubdivision

The sub/super city.

municipality

The city/town.

countrySecondarySubdivision

The county.

countryTertiarySubdivision

The named area.

countrySubdivision

The state or province.

postalCode

The postal code.

extendedPostalCode

The extended postal code (availability dependent on region).

countryCode

The country code.

country

The name of the country.

countryCodeIso3

The ISO3-standard country code. See https://www.iso.org/obp/ui/#search for more details.

freeformAddress

The freeform address - the full address in a usable form.

countrySubdivisionName

The full name of the first level of a country administrative hierarchy. This field only appears in case countrySubdivision is presented in an abbreviated form. Supported only for USA, Canada, and Great Britain.

localName

An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit.

streetNameAndNumber

The street name and number combined in the correct order.

postalName

An address component which represents the name for a postal code that is related to a single administrative area, city, town, or other populated place.

countrySubdivisionCode

Code prefixed by countryCode and a hyphen (countryCode-countrySubdivisionCode) forms the ISO 3166-2 code. Examples: TX for Texas, SCT for Scotland, ON for Ontario, ZE for Zeeland and BB for Brandenburg.

neighborhoodName

Neighborhoods have in common that they often have a semi-official status and may not be part of an administrative structure. Neighborhood does not fit specifically in an administrative structure. Neighborhoods are areas formed on a cultural, social or economical basis, it may have touristic appeal as a nice area with a specific atmosphere like a restaurant area. Neighborhoods typically don't have official borders and they typically don't have 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.

Throws

IllegalArgumentException

if all properties are null.

Constructors

Address

fun Address(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 = "")