search-sdk/com.mapbox.search.result/SearchAddress

SearchAddress

class SearchAddress @JvmOverloads constructor(val houseNumber: String? = null, val street: String? = null, val neighborhood: String? = null, val locality: String? = null, val postcode: String? = null, val place: String? = null, val district: String? = null, val region: String? = null, val country: String? = null, val regionInfo: SearchAddressRegion? = null, val countryInfo: SearchAddressCountry? = null) : Parcelable

Represents address of the search result.

Constructors

SearchAddress

@JvmOverloads

fun 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, regionInfo: SearchAddressRegion? = null, countryInfo: SearchAddressCountry? = null)

Types

Builder

class Builder

Builder for comfortable creation of SearchAddress instance.

FormatComponent

class FormatComponent

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

FormatStyle

abstract class FormatStyle

Describes how detailed should be formatted address in string representation.

Functions

copy

fun copy(houseNumber: String? = this.houseNumber, street: String? = this.street, neighborhood: String? = this.neighborhood, locality: String? = this.locality, postcode: String? = this.postcode, place: String? = this.place, district: String? = this.district, region: String? = this.region, country: String? = this.country, regionInfo: SearchAddressRegion? = this.regionInfo, countryInfo: SearchAddressCountry? = this.countryInfo): SearchAddress

Creates new SearchAddress from current instance.

describeContents

abstract fun describeContents(): Int

formattedAddress

@JvmOverloads

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

Formats address. Note that this function doesn't take into account locale and just concatenates address parts separated by a comma. The parts of the address used for formatting are determined by the formatting style.

toBuilder

fun toBuilder(): SearchAddress.Builder

Creates new SearchAddress.Builder from current SearchAddress instance.

writeToParcel