Package com.mapbox.search

Types

ApiType

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

AsyncOperationTask

Represents the result (task handle) of an asynchronous operation.

CategorySearchOptions

class CategorySearchOptions @JvmOverloads() constructor(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, indexableRecordsDistanceThresholdMeters: Double?) : Parcelable

Search options, used for category search.

CompletionCallback

interface CompletionCallback<T>

Interface definition for a commonly used in the Search SDK callback to be invoked when asynchronous operation completes.

Country

class Country(code: String) : Parcelable

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

DistanceCalculator

interface DistanceCalculator

Distance calculator for WGS84 (Earth as spheroid).

EtaType

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

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

Image information.

Language

class Language(code: String) : Parcelable

Preferred languages of the search results.

MapboxSearchSdk

object MapboxSearchSdk

The entry point to initialize Search SDK.

OfflineIndexChangeEvent

class OfflineIndexChangeEvent(type: OfflineIndexChangeEvent.EventType, regionId: String, dataset: String, version: String)

Type that holds information about changes in the offline search index.

OfflineIndexErrorEvent

class OfflineIndexErrorEvent(regionId: String, dataset: String, version: String, tile: String, message: String)

Type that holds information about error event in the offline search index.

OfflineReverseGeoOptions

class OfflineReverseGeoOptions(center: Point) : Parcelable

Options for offline reverse geocoding.

OfflineSearchEngine

interface OfflineSearchEngine

The OfflineSearchEngine interface provides forward and reverse geocoding search that works offline.

OfflineSearchEngineSettings

class OfflineSearchEngineSettings(tileStore: TileStore?, tilesBaseUri: URI?)

Settings used for OfflineSearchEngine configuration.

OfflineSearchOptions

class OfflineSearchOptions @JvmOverloads() constructor(proximity: Point?, limit: Int?, origin: Point?) : Parcelable

Options for the offline search.

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<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

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.

SearchCancellationException

class SearchCancellationException(message: String) : RuntimeException

Exception thrown when a search request was automatically cancelled by the Search SDK.

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)

Unlike OfflineSearchEngine, SearchEngine API requires an online connection to execute the requests.

SearchEngineSettings

class SearchEngineSettings @JvmOverloads() constructor(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: SearchNavigationProfile, etaType: EtaType?) : Parcelable

Additional search options to improve navigation experience.

SearchNavigationProfile

class SearchNavigationProfile(rawName: String) : Parcelable

Type of movement.

SearchOptions

class SearchOptions @JvmOverloads() constructor(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, indexableRecordsDistanceThresholdMeters: Double?) : Parcelable

Search options, used for forward geocoding.

SearchRequestException

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

class SearchResultMetadata : Parcelable

Search result metadata container.

SearchSdkSettings

class SearchSdkSettings @JvmOverloads() constructor(maxHistoryRecordsAmount: Int)