Package com.mapbox.search

Types

ApiType
Link copied to clipboard
enum ApiType : Enum<ApiType>
Experimental API, can be changed or removed in the next SDK releases.
AsyncOperationTask
Link copied to clipboard
interface AsyncOperationTask
Represents the result (task handle) of an asynchronous operation.
CategorySearchEngine
Link copied to clipboard
interface CategorySearchEngine
Category search engine, used for search by category.
CategorySearchOptions
Link copied to clipboard
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
Link copied to clipboard
interface CompletionCallback<T>
Interface definition for a commonly used in the Search SDK callback to be invoked when asynchronous operation completes.
Country
Link copied to clipboard
class Country(code: String) : Parcelable
Countries list to use in com.mapbox.search.SearchOptions.
DataProviderInitializationCallback
Link copied to clipboard
interface DataProviderInitializationCallback
Interface definition for a callback to be invoked when default data provider has been initialized and is ready to use.
DistanceCalculator
Link copied to clipboard
interface DistanceCalculator
Distance calculator for WGS84 (Earth as spheroid).
EtaType
Link copied to clipboard
class EtaType(rawName: String) : Parcelable
Type of ETA calculation.
HighlightsCalculator
Link copied to clipboard
interface HighlightsCalculator
Used to calculate which parts of exact search result name will be highlighted.
ImageInfo
Link copied to clipboard
class ImageInfo(url: String, @Px() width: Int, @Px() height: Int) : Parcelable
Image information.
IndexableDataProvidersRegistry
Link copied to clipboard
interface IndexableDataProvidersRegistry
Experimental API, can be changed or removed in the next SDK releases.
Language
Link copied to clipboard
class Language(code: String) : Parcelable
Preferred languages of the search results.
MapboxSearchSdk
Link copied to clipboard
object MapboxSearchSdk
The entry point to initialize Search SDK.
OfflineIndexChangeEvent
Link copied to clipboard
class OfflineIndexChangeEvent(type: OfflineIndexChangeEvent.EventType, regionId: String, dataset: String, version: String)
Type that holds information about changes in the offline search index.
OfflineIndexErrorEvent
Link copied to clipboard
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
Link copied to clipboard
class OfflineReverseGeoOptions(center: Point) : Parcelable
Options for offline reverse geocoding.
OfflineSearchEngine
Link copied to clipboard
interface OfflineSearchEngine
The OfflineSearchEngine interface provides forward and reverse geocoding search that works offline.
OfflineSearchOptions
Link copied to clipboard
class OfflineSearchOptions @JvmOverloads() constructor(proximity: Point?, limit: Int?, origin: Point?) : Parcelable
Options for the offline search.
OfflineSearchSettings
Link copied to clipboard
class OfflineSearchSettings(tileStore: TileStore?, tilesBaseUri: URI?)
Defines options for offline tiles endpoint.
QueryType
Link copied to clipboard
enum QueryType : Enum<QueryType>
Values to filter results to include only a subset (one or more) of the available feature types.
RequestOptions
Link copied to clipboard
class RequestOptions : Parcelable
Options describing search request.
ResponseInfo
Link copied to clipboard
class ResponseInfo : Parcelable
Information about search response and associated search request.
ReverseGeocodingSearchEngine
Link copied to clipboard
interface ReverseGeocodingSearchEngine
Used for reverse geocoding (looking up place by geographic coordinates to retrieve its name and address).
ReverseGeoOptions
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
class RouteOptions(route: List<Point>, deviation: RouteOptions.Deviation) : Parcelable
Options to configure Route for search along the route functionality.
SearchCallback
Link copied to clipboard
interface SearchCallback
Search result callback for category search and reverse geocoding.
SearchEngine
Link copied to clipboard
interface SearchEngine
Used for forward geocoding (looking up a place by name to retrieve its geographic coordinates).
SearchMultipleSelectionCallback
Link copied to clipboard
interface SearchMultipleSelectionCallback
Callback called when multiple selection request completes.
SearchNavigationOptions
Link copied to clipboard
class SearchNavigationOptions @JvmOverloads() constructor(navigationProfile: SearchNavigationProfile, etaType: EtaType?) : Parcelable
Additional search options to improve navigation experience.
SearchNavigationProfile
Link copied to clipboard
class SearchNavigationProfile(rawName: String) : Parcelable
Type of movement.
SearchOptions
Link copied to clipboard
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
Link copied to clipboard
class SearchRequestException(message: String, code: Int, cause: Exception?) : RuntimeException
Exception thrown when an HTTP response was not successful, i.e.
SearchRequestTask
Link copied to clipboard
interface SearchRequestTask
Represents any request from any search engine.
SearchResultMetadata
Link copied to clipboard
class SearchResultMetadata : Parcelable
Search result metadata container.
SearchSdkSettings
Link copied to clipboard
class SearchSdkSettings @JvmOverloads() constructor(geocodingEndpointBaseUrl: String, singleBoxSearchBaseUrl: String?, maxHistoryRecordsAmount: Int)
Settings used for Search SDK initialization.
SearchSelectionCallback
Link copied to clipboard
interface SearchSelectionCallback : SearchSuggestionsCallback
Callback for SearchResult, resolved from SearchSuggestion.
SearchSuggestionsCallback
Link copied to clipboard
interface SearchSuggestionsCallback
Used in the first step of forward geocoding to get a list of SearchSuggestion.
SelectOptions
Link copied to clipboard
class SelectOptions(addResultToHistory: Boolean) : Parcelable
Bunch of options used by SearchEngine.select function.
ServiceProvider
Link copied to clipboard
interface ServiceProvider
This class provides access to search-related services and utility classes.
ViewportProvider
Link copied to clipboard
fun fun interface ViewportProvider
Provides map viewport, if you have map in your application.