Package com.mapbox.search

Types

ApiType

The type of the API used by one of the Search Engines.

CategorySearchOptions

class CategorySearchOptions @JvmOverloads() constructor(proximity: Point?, boundingBox: BoundingBox?, countries: List<IsoCountryCode>?, fuzzyMatch: Boolean?, languages: List<IsoLanguageCode>?, limit: Int?, requestDebounce: Int?, origin: Point?, navigationProfile: NavigationProfile?, routeOptions: RouteOptions?, unsafeParameters: Map<String, String>?, ignoreIndexableRecords: Boolean, indexableRecordsDistanceThresholdMeters: Double?) : Parcelable

Search options, used for category search.

EtaType

class EtaType(rawName: String) : Parcelable

Type of ETA calculation.

QueryType

enum QueryType : Enum<QueryType>

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

RequestOptions

class RequestOptions : Parcelable

Options describing search request.

ResponseInfo

class ResponseInfo : Parcelable

Information about search response and associated search request.

ReverseGeoOptions

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

Search options for reverse geocoding.

ReverseMode

enum ReverseMode : Enum<ReverseMode>

Decides how results are sorted in a reverse geocoding query if multiple results are requested using a limit other than 1.

RouteOptions

class RouteOptions(route: List<Point>, deviation: RouteOptions.Deviation) : Parcelable

Options to configure Route for search along the route functionality.

SearchCallback

interface SearchCallback

Search result callback for category search and reverse geocoding.

SearchEngine

interface SearchEngine

Performs

forward geocoding (looking up a place by name to retrieve its geographic coordinates)
category search(search for places by category name)
reverse geocoding(search for places by geographic coordinate)

SearchEngine API requires an online connection to execute the requests.

SearchEngineSettings

class SearchEngineSettings @JvmOverloads() constructor(accessToken: String, locationEngine: LocationEngine, viewportProvider: ViewportProvider?, geocodingEndpointBaseUrl: String, singleBoxSearchBaseUrl: String?)

Settings used for SearchEngine configuration.

SearchMultipleSelectionCallback

interface SearchMultipleSelectionCallback

Callback called when multiple selection request completes.

SearchNavigationOptions

class SearchNavigationOptions @JvmOverloads() constructor(navigationProfile: NavigationProfile, etaType: EtaType?) : Parcelable

Additional search options to improve navigation experience.

SearchOptions

class SearchOptions @JvmOverloads() constructor(proximity: Point?, boundingBox: BoundingBox?, countries: List<IsoCountryCode>?, fuzzyMatch: Boolean?, languages: List<IsoLanguageCode>?, limit: Int?, types: List<QueryType>?, requestDebounce: Int?, origin: Point?, navigationOptions: SearchNavigationOptions?, routeOptions: RouteOptions?, unsafeParameters: Map<String, String>?, ignoreIndexableRecords: Boolean, indexableRecordsDistanceThresholdMeters: Double?) : Parcelable

Search options, used for forward geocoding.

SearchResultMetadata

class SearchResultMetadata : Parcelable

Search result metadata container.

SearchSelectionCallback

interface SearchSelectionCallback : SearchSuggestionsCallback

Callback for SearchResult, resolved from SearchSuggestion.

SearchSuggestionsCallback

interface SearchSuggestionsCallback

Used in the first step of forward geocoding to get a list of SearchSuggestion.

SelectOptions

class SelectOptions(addResultToHistory: Boolean) : Parcelable