sdk / com.mapbox.search.result / SearchAddress

SearchAddress

data class SearchAddress : Parcelable

Represents address of the search result.

Types

FormatComponent

Values for specifying the portions of the address to be included in the formatted address string.

enum class FormatComponent

FormatStyle

Describes how detailed should be formatted address in string representation.

sealed class FormatStyle

Constructors

<init>

Represents address of the search result.

SearchAddress(houseNumber: String? = null, street: String? = null, neighborhood: String? = null, locality: String? = null, postcode: String? = null, place: String? = null, district: String? = null, region: String? = null, country: String? = null)

Properties

country

Address country.

val country: String?

district

Address district.

val district: String?

houseNumber

Address house number.

val houseNumber: String?

locality

Address locality.

val locality: String?

neighborhood

Address neighborhood.

val neighborhood: String?

place

Address place.

val place: String?

postcode

Address postcode.

val postcode: String?

region

Address region.

val region: String?

street

Address street.

val street: String?

Functions

formattedAddress

Build address string in requested style.

fun formattedAddress(style: FormatStyle = FormatStyle.Medium): String?