navigation-ux-search-api/com.mapbox.dash.sdk.search.api/DashSearchEngine

DashSearchEngine

interface DashSearchEngine

Customizable search engine that might override default search engine by specified policy

See also

Properties

Link copied to clipboard
abstract val processingPolicyFlag: Int

The policy flag how results should be processed: return only overridden result or return overridden search results with default search API.

Functions

Link copied to clipboard
abstract suspend fun brandSearch(searchRequest: DashSearchRequest, options: DashBrandOptions): List<DashSearchResult>

Performs a search request for places based on a brand name. This functionality is only supported for a SearchEngine with ApiType.SEARCH_BOX. For other api types callback will be called with UnsupportedOperationException immediately.

Link copied to clipboard
abstract suspend fun categorySearch(searchRequest: DashSearchRequest, displayName: String, options: DashCategorySearchOptions): List<DashSearchResult>

Do a category search by specified searchRequest

Link copied to clipboard
abstract suspend fun forward(request: DashSearchRequest, options: DashForwardOptions): List<DashSearchResult>

Search results for a given search request.

Link copied to clipboard
abstract suspend fun search(request: DashSearchRequest, options: DashSearchOptions): List<DashSearchSuggestion>

Search suggestions for a given search request.