sdk / com.mapbox.search

Package com.mapbox.search

Types

CategorySearchEngine

Category search engine, used for search by category. Instance of it can be retrieved from MapboxSearchSdk. Result will be delivered on the main thread.

interface CategorySearchEngine

Country

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

data class Country : Parcelable

DistanceCalculator

Fast distance calculator for WGS84 (Earth as spheroid). Should be initialized by latitude and used in some not far around area. Expected error is 0.04%.

interface DistanceCalculator

HighlightsCalculator

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

interface HighlightsCalculator

Language

Preferred languages of the search results.

data class Language : Parcelable

MapboxSearchSdk

The entry point to initialize Search SDK.

object MapboxSearchSdk

QueryType

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

enum class QueryType

RequestOptions

Options describing search request.

data class RequestOptions : Parcelable

ReverseGeocodingSearchEngine

Used for reverse geocoding. Instance of it can be retrieved from MapboxSearchSdk. Result will be delivered on the main thread.

interface ReverseGeocodingSearchEngine

ReverseGeoOptions

Search options for reverse geocoding.

data class ReverseGeoOptions : Parcelable

ReverseMode

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

enum class ReverseMode

SearchCallback

Search result callback for category search and reverse geocoding. When an event happens, the corresponding method will be called on the main thread.

interface SearchCallback

SearchEngine

Used for forward geocoding (looking up a place by name to retrieve its geographic coordinates). Instance of it can be retrieved from MapboxSearchSdk. Results will be delivered on the main thread.

interface SearchEngine

SearchOptions

Search options, used for forward geocoding and category search.

data class SearchOptions : Parcelable

SearchRequestTask

Represents any request from any search engine. Should be cancelled if you leave the screen or application and result of search request do not needed anymore to avoid memory leaks.

interface SearchRequestTask

SearchSelectionCallback

Callback for SearchResult, resolved from SearchSuggestion. onResult will be called on the main thread.

interface SearchSelectionCallback : SearchSuggestionsCallback

SearchSuggestionsCallback

Used in the first step of forward geocoding to get a list of SearchSuggestion. When an event happens, the corresponding method will be called on the main thread.

interface SearchSuggestionsCallback

ServiceProvider

This class provides access to search-related services and utility classes.

interface ServiceProvider

ViewportProvider

Used to provide map viewport to MapboxSearchSDK instance, if you have map in your application. Provided viewport used for better and more accurate analytics data.

interface ViewportProvider

Exceptions

SearchRequestException

Exception thrown when an HTTP response was not successful, i.e. if the code is not in [200..300).

data class SearchRequestException : RuntimeException