search-sdk/com.mapbox.search/SearchEngineSettings

SearchEngineSettings

class SearchEngineSettings @JvmOverloads constructor(val locationProvider: LocationProvider? = defaultLocationProvider(), val viewportProvider: ViewportProvider? = null, val geocodingEndpointBaseUrl: String = DEFAULT_ENDPOINT_GEOCODING, val singleBoxSearchBaseUrl: String? = null, val baseUrl: String? = null)

Settings used for SearchEngine configuration.

See also

Constructors

Link copied to clipboard
@JvmOverloads
fun SearchEngineSettings(locationProvider: LocationProvider? = defaultLocationProvider(), viewportProvider: ViewportProvider? = null, geocodingEndpointBaseUrl: String = DEFAULT_ENDPOINT_GEOCODING, singleBoxSearchBaseUrl: String? = null, baseUrl: String? = null)

Types

Link copied to clipboard
class Builder

Builder for SearchEngineSettings.

Functions

Link copied to clipboard
fun copy(locationProvider: LocationProvider? = this.locationProvider, viewportProvider: ViewportProvider? = this.viewportProvider, geocodingEndpointBaseUrl: String = this.geocodingEndpointBaseUrl, singleBoxSearchBaseUrl: String? = this.singleBoxSearchBaseUrl, baseUrl: String? = this.baseUrl): SearchEngineSettings

Creates a copy of this object with overridden parameters.

Link copied to clipboard
fun toBuilder(): SearchEngineSettings.Builder

Creates a new SearchEngineSettings.Builder from this instance.

Properties

Link copied to clipboard
val baseUrl: String? = null

Base endpoint URL.

Link copied to clipboard
val geocodingEndpointBaseUrl: String

Geocoding API endpoint URL.

Link copied to clipboard
val locationProvider: LocationProvider?

The mechanism responsible for providing location approximations to the SDK. By default LocationProvider is provided by LocationServiceFactory. Note that this class requires Manifest.permission.ACCESS_COARSE_LOCATION or Manifest.permission.ACCESS_FINE_LOCATION to work properly.

Link copied to clipboard
val singleBoxSearchBaseUrl: String? = null

Single Box Search endpoint URL.

Link copied to clipboard
val viewportProvider: ViewportProvider? = null

Viewport provider instance.