Package com.mapbox.search

Types

ApiType

Experimental API, can be changed or removed in the next SDK releases.

CategorySearchEngine

Category search engine, used for search by category.

CategorySearchOptions

data class CategorySearchOptions(proximity: Point?, boundingBox: BoundingBox?, countries: List<Country>?, fuzzyMatch: Boolean?, languages: List<Language>?, limit: Int?, requestDebounce: Int?, origin: Point?, navigationProfile: SearchNavigationProfile?, routeOptions: RouteOptions?, unsafeParameters: Map<String, String>?, ignoreIndexableRecords: Boolean) : Parcelable

Search options, used for category search.

Country

data class Country(code: String) : Parcelable

Countries list to use in com.mapbox.search.SearchOptions.

DistanceCalculator

interface DistanceCalculator

Fast distance calculator for WGS84 (Earth as spheroid).

EtaType

data class EtaType(rawName: String) : Parcelable

Type of ETA calculation.

HighlightsCalculator

interface HighlightsCalculator

Used to calculate which parts of exact search result name will be highlighted.

ImageInfo

data class ImageInfo(url: String, @Px() width: Int, @Px() height: Int) : Parcelable

Image information.

Language

data class Language(code: String) : Parcelable

Preferred languages of the search results.

MapboxSearchSdk

object MapboxSearchSdk

The entry point to initialize Search SDK.

QueryType

enum QueryType : Enum<QueryType>

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

RequestOptions

data class RequestOptions : Parcelable

Options describing search request.

ResponseInfo

data class ResponseInfo : Parcelable

Information about search response and associated search request.

ReverseGeocodingSearchEngine

interface ReverseGeocodingSearchEngine

Used for reverse geocoding.

ReverseGeoOptions

data class ReverseGeoOptions(center: Point, countries: List<Country>?, languages: List<Language>?, 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

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

Options to configure Route for search along the route functionality.

SearchCallback

@UiThread()

interface SearchCallback

Search result callback for category search and reverse geocoding.

SearchEngine

interface SearchEngine

Used for forward geocoding (looking up a place by name to retrieve its geographic coordinates).

SearchMultipleSelectionCallback

@UiThread()

interface SearchMultipleSelectionCallback

Callback called when multiple selection request completes.

SearchNavigationOptions

data class SearchNavigationOptions(navigationProfile: SearchNavigationProfile, etaType: EtaType?) : Parcelable

Additional search options to improve navigation experience.

SearchNavigationProfile

data class SearchNavigationProfile(rawName: String) : Parcelable

Type of movement.

SearchOptions

data class SearchOptions(proximity: Point?, boundingBox: BoundingBox?, countries: List<Country>?, fuzzyMatch: Boolean?, languages: List<Language>?, limit: Int?, types: List<QueryType>?, requestDebounce: Int?, origin: Point?, navigationOptions: SearchNavigationOptions?, routeOptions: RouteOptions?, unsafeParameters: Map<String, String>?, ignoreIndexableRecords: Boolean) : Parcelable

Search options, used for forward geocoding.

SearchRequestException

data class SearchRequestException(message: String, code: Int, cause: Exception?) : RuntimeException

Exception thrown when an HTTP response was not successful, i.e.

SearchRequestTask

interface SearchRequestTask

Represents any request from any search engine.

SearchResultMetadata

data class SearchResultMetadata : Parcelable

Search result metadata container.

SearchSelectionCallback

@UiThread()