Builder

class Builder(center: Point)

Builder for comfortable creation of ReverseGeoOptions instance.

Constructors

Link copied to clipboard
fun Builder(center: Point)

Functions

Link copied to clipboard

Create ReverseGeoOptions instance from builder data.

Link copied to clipboard
fun countries(vararg countries: IsoCountryCode): ReverseGeoOptions.Builder
fun countries(countries: List<IsoCountryCode>): ReverseGeoOptions.Builder

Limit results to one or more countries.

Link copied to clipboard
fun languages(vararg languages: IsoLanguageCode): ReverseGeoOptions.Builder
fun languages(languages: List<IsoLanguageCode>): ReverseGeoOptions.Builder

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.

Link copied to clipboard

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

Filter results to include only a subset (one or more) of the available feature types.