android-components / mozilla.components.feature.awesomebar.provider / SearchSuggestionProvider

SearchSuggestionProvider

class SearchSuggestionProvider : SuggestionProvider (source)

A AwesomeBar.SuggestionProvider implementation that provides a suggestion containing search engine suggestions (as chips) from the passed in SearchEngine.

Types

Name Summary
Mode enum class Mode

Constructors

Name Summary
<init> SearchSuggestionProvider(searchEngine: SearchEngine, searchUseCase: SearchUseCase, fetchClient: Client, limit: Int = 15, mode: Mode = Mode.SINGLE_SUGGESTION, icon: <ERROR CLASS>? = null, showDescription: Boolean = true)
Creates a SearchSuggestionProvider for the provided SearchEngine.SearchSuggestionProvider(context: <ERROR CLASS>, searchEngineManager: SearchEngineManager, searchUseCase: SearchUseCase, fetchClient: Client, limit: Int = 15, mode: Mode = Mode.SINGLE_SUGGESTION, icon: <ERROR CLASS>? = null, showDescription: Boolean = true)
Creates a SearchSuggestionProvider using the default engine as returned by the provided SearchEngineManager.

Properties

Name Summary
id val id: String
A unique ID used for identifying this provider.
shouldClearSuggestions val shouldClearSuggestions: Boolean
If true an AwesomeBar implementation can clear the previous suggestions of this provider as soon as the user continues to type. If this is false an AwesomeBar implementation is allowed to keep the previous suggestions around until the provider returns a new list of suggestions for the updated text.

Functions

Name Summary
onInputChanged suspend fun onInputChanged(text: String): List<Suggestion>
Fired whenever the user changes their input, after they have started interacting with the awesome bar.

Inherited Functions

Name Summary
onInputCancelled open fun onInputCancelled(): Unit
Fired when the user has cancelled their interaction with the awesome bar.
onInputStarted open fun onInputStarted(): List<Suggestion>
Fired when the user starts interacting with the awesome bar by entering text in the toolbar.

Extension Functions

Name Summary
loadResourceAsString fun Any.loadResourceAsString(path: String): String
Loads a file from the resources folder and returns its content as a string object.