ReverseGeoOptions

class ReverseGeoOptions @JvmOverloads constructor(val center: Point, val countries: List<IsoCountryCode>? = null, val languages: List<IsoLanguageCode>? = defaultSearchOptionsLanguage(), val limit: Int? = null, val reverseMode: ReverseMode? = null, val types: List<QueryType>? = null) : Parcelable

Search options for reverse geocoding.

See also

Constructors

Link copied to clipboard
fun ReverseGeoOptions(center: Point, countries: List<IsoCountryCode>? = null, languages: List<IsoLanguageCode>? = defaultSearchOptionsLanguage(), limit: Int? = null, reverseMode: ReverseMode? = null, types: List<QueryType>? = null)

Types

Link copied to clipboard
class Builder(center: Point)

Builder for comfortable creation of ReverseGeoOptions instance.

Functions

Link copied to clipboard
fun copy(center: Point = this.center, countries: List<IsoCountryCode>? = this.countries, languages: List<IsoLanguageCode>? = this.languages, limit: Int? = this.limit, reverseMode: ReverseMode? = this.reverseMode, types: List<QueryType>? = this.types): ReverseGeoOptions

Creates new ReverseGeoOptions from current instance.

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
val center: Point

Coordinates to resolve.

Link copied to clipboard
val countries: List<IsoCountryCode>? = null

Limit results to one or more countries.

Link copied to clipboard
val languages: List<IsoLanguageCode>?

Specify the user’s language. This parameter controls the language of the text supplied in responses, and also affects result scoring, with results matching the user’s query in the requested language being preferred over results that match in another language. For example, an autocomplete query for things that start with Frank might return Frankfurt as the first result with an English (en) language parameter, but Frankreich (“France”) with a German (de) language parameter. If language is not set explicitly, then language from default system locale will be used.

Link copied to clipboard
val limit: Int? = null

Specify the maximum number of results to return. The default is 1 and the maximum supported is 5. The default behavior in reverse geocoding is to return at most one feature at each of the multiple levels of the administrative hierarchy (for example, one address, one region, one country). Increasing the limit allows returning multiple features of the same type, but only for one type (for example, multiple address results). Consequently, setting limit to a higher-than-default value requires specifying exactly one types parameter.

Link copied to clipboard

Decides how results are sorted in a reverse geocoding query.

Link copied to clipboard
val types: List<QueryType>? = null

Filter results to include only a subset (one or more) of the available feature types. Options are country, region, postcode, district, place, locality, neighborhood, address, and poi.