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.
CategorySearchOptions
Link copied to clipboard
class CategorySearchOptions @JvmOverloads() constructor(proximity: Point?, boundingBox: BoundingBox?, countries: List<IsoCountryCode>?, fuzzyMatch: Boolean?, languages: List<IsoLanguageCode>?, 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.
EtaType
Link copied to clipboard
class EtaType(rawName: String) : Parcelable
Type of ETA calculation.
ImageInfo
Link copied to clipboard
class ImageInfo(url: String, @Px() width: Int, @Px() height: Int) : Parcelable
Image information.
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.
ReverseGeoOptions
Link copied to clipboard
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
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
PerformsSearchEngine API requires an online connection to execute the requests.
SearchEngineSettings
Link copied to clipboard
class SearchEngineSettings @JvmOverloads() constructor(accessToken: String, locationEngine: LocationEngine, viewportProvider: ViewportProvider?, geocodingEndpointBaseUrl: String, singleBoxSearchBaseUrl: String?)
Settings used for SearchEngine configuration.
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<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
Link copied to clipboard
class SearchResultMetadata : Parcelable
Search result metadata container.
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.