sdk/com.mapbox.search

Package-level declarations

Types

ApiType

enum ApiType : Enum<ApiType>

The type of the API used by one of the Search Engines.

AttributeSet

enum AttributeSet : Enum<AttributeSet>

Besides the basic metadata attributes described above, developers can request additional attributes.

CategorySearchOptions

class CategorySearchOptions @JvmOverloads constructor(val proximity: Point? = null, val boundingBox: BoundingBox? = null, val countries: List<IsoCountryCode>? = null, val fuzzyMatch: Boolean? = null, val languages: List<IsoLanguageCode>? = defaultSearchOptionsLanguage(), val limit: Int? = null, val requestDebounce: Int? = null, val origin: Point? = null, val navigationProfile: NavigationProfile? = null, val routeOptions: RouteOptions? = null, val unsafeParameters: Map<String, String>? = null, val ignoreIndexableRecords: Boolean = false, val indexableRecordsDistanceThresholdMeters: Double? = null, val ensureResultsPerCategory: Boolean? = null, val attributeSets: List<AttributeSet>? = null) : Parcelable

Search options, used for category search.

EtaType

class EtaType(val rawName: String) : Parcelable

Type of ETA calculation.

ForwardSearchOptions

class ForwardSearchOptions : Parcelable

Search options, used for the "Text Search".

QueryType

enum QueryType : Enum<QueryType>

Values to filter results to include only a subset (one or more) of the available feature types. See the Administrative unit types section for details about the 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(val center: Point, val countries: List<IsoCountryCode>? = null, val languages: List<IsoLanguageCode>? = defaultSearchOptionsLanguage(), val limit: Int? = null, val reverseMode: ReverseMode? = null, val types: List<QueryType>? = null) : 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(val route: List<Point>, val 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.

SearchEngine

interface SearchEngine

Performs

SearchEngineSettings

class SearchEngineSettings @JvmOverloads constructor(val locationProvider: LocationProvider? = defaultLocationProvider(), val viewportProvider: ViewportProvider? = null, val geocodingEndpointBaseUrl: String = DEFAULT_ENDPOINT_GEOCODING, val singleBoxSearchBaseUrl: String? = null, val baseUrl: String? = null)

Settings used for SearchEngine configuration.

SearchMultipleSelectionCallback

interface SearchMultipleSelectionCallback

Callback called when multiple selection request completes.

SearchNavigationOptions

class SearchNavigationOptions @JvmOverloads constructor(val navigationProfile: NavigationProfile, val etaType: EtaType? = null) : Parcelable

Additional search options to improve navigation experience.

SearchOptions

class SearchOptions @JvmOverloads constructor(val proximity: Point? = null, val boundingBox: BoundingBox? = null, val countries: List<IsoCountryCode>? = null, val fuzzyMatch: Boolean? = null, val languages: List<IsoLanguageCode>? = defaultSearchOptionsLanguage(), val limit: Int? = null, val types: List<QueryType>? = null, val requestDebounce: Int? = null, val origin: Point? = null, val navigationOptions: SearchNavigationOptions? = null, val routeOptions: RouteOptions? = null, val unsafeParameters: Map<String, String>? = null, val ignoreIndexableRecords: Boolean = false, val indexableRecordsDistanceThresholdMeters: Double? = null) : Parcelable

Search options, used for forward geocoding.

SearchResultCallback

interface SearchResultCallback

Search callback for when only one response is expected

SearchResultMetadata

class SearchResultMetadata : Parcelable

Search result metadata container. Provides geo place's detailed information if available.

SearchSelectionCallback

interface SearchSelectionCallback : SearchSuggestionsCallback

Callback for SearchResult, resolved from SearchSuggestion.

SearchSuggestionsCallback

interface SearchSuggestionsCallback