SearchFragment
class SearchFragment : Fragment
A fragment to handle searches. An application will supply an implementation of the SearchResultProvider interface to handle the search and return an ObjectAdapter containing the results. The results are rendered into a RowsFragment, in the same way that they are in a .
A SpeechRecognizer object will be created for which your application will need to declare android.permission.RECORD_AUDIO in AndroidManifest file. If app's target version is >= 23 and the device version is >= 23, a permission dialog will show first time using speech recognition. 0 will be used as requestCode in requestPermissions() call. setSpeechRecognitionCallback is deprecated.
Speech recognition is automatically started when fragment is created, but not when fragment is restored from an instance state. Activity may manually call startRecognition, typically in onNewIntent().
Summary
Nested types |
|---|
interface SearchFragment.SearchResultProviderSearch API to be provided by the application. |
Public constructors |
|---|
Public functions |
|
|---|---|
java-static Bundle! |
createArgs(args: Bundle!, query: String!) |
java-static Bundle! |
createArgs(args: Bundle!, query: String!, title: String!) |
Unit |
displayCompletions(completions: Array<CompletionInfo!>!)Displays the completions shown by the IME. |
Unit |
displayCompletions(completions: (Mutable)List<String!>!)Displays the completions shown by the IME. |
Drawable! |
Returns the badge drawable in the search bar. |
Intent! |
Returns an intent that can be used to request speech recognition. |
RowsFragment! |
Returns RowsFragment that shows result rows. |
String! |
getTitle()Returns the title set in the search bar. |
java-static SearchFragment! |
newInstance(query: String!)Creates a search fragment with a given search query. |
Unit |
This function is deprecated. |
View? |
onCreateView(This function is deprecated. |
Unit |
This function is deprecated. |
Unit |
This function is deprecated. |
Unit |
onPause()This function is deprecated. |
Unit |
onRequestPermissionsResult(This function is deprecated. |
Unit |
onResume()This function is deprecated. |
Unit |
onStart()This function is deprecated. |
Unit |
setBadgeDrawable(drawable: Drawable!)Sets the badge drawable that will be shown inside the search bar next to the title. |
Unit |
Sets an item clicked listener for the results. |
Unit |
Sets an item selection listener for the results. |
Unit |
Sets background color of not-listening state search orb. |
Unit |
Sets background color of listening state search orb. |
Unit |
setSearchQuery(intent: Intent!, submit: Boolean)Sets the text of the search query based on the |
Unit |
setSearchQuery(query: String!, submit: Boolean)Sets the text of the search query and optionally submits the query. |
Unit |
setSearchResultProvider(Sets the search provider that is responsible for returning results for the search query. |
Unit |
This function is deprecated. Launching voice recognition activity is no longer supported. |
Unit |
Sets the title string to be be shown in an empty search bar. |
Unit |
Starts speech recognition. |
Inherited Constants |
||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Inherited functions |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public constructors
Public functions
java-static fun createArgs(args: Bundle!, query: String!): Bundle!
| Parameters | |
|---|---|
args: Bundle! |
Bundle to use for the arguments, if null a new Bundle will be created. |
fun displayCompletions(completions: Array<CompletionInfo!>!): Unit
Displays the completions shown by the IME. An application may provide a list of query completions that the system will show in the IME.
| Parameters | |
|---|---|
completions: Array<CompletionInfo!>! |
A list of completions to show in the IME. Setting to null or empty will clear the list. |
fun displayCompletions(completions: (Mutable)List<String!>!): Unit
Displays the completions shown by the IME. An application may provide a list of query completions that the system will show in the IME.
fun getRecognizerIntent(): Intent!
Returns an intent that can be used to request speech recognition. Built from the base ACTION_RECOGNIZE_SPEECH plus extras:
EXTRA_LANGUAGE_MODELset toLANGUAGE_MODEL_FREE_FORMEXTRA_PARTIAL_RESULTSset to trueEXTRA_PROMPTset to the search bar hint text
setSearchQuery.fun getRowsFragment(): RowsFragment!
Returns RowsFragment that shows result rows. RowsFragment is initialized after SearchFragment.onCreateView().
| Returns | |
|---|---|
RowsFragment! |
RowsFragment that shows result rows. |
java-static fun newInstance(query: String!): SearchFragment!
Creates a search fragment with a given search query.
You should only use this if you need to start the search fragment with a pre-filled query.
| Parameters | |
|---|---|
query: String! |
The search query to begin with. |
| Returns | |
|---|---|
SearchFragment! |
A new SearchFragment. |
fun onCreateView(
inflater: LayoutInflater!,
container: ViewGroup?,
savedInstanceState: Bundle!
): View?
fun onRequestPermissionsResult(
requestCode: Int,
permissions: Array<String!>!,
grantResults: IntArray!
): Unit
fun setBadgeDrawable(drawable: Drawable!): Unit
Sets the badge drawable that will be shown inside the search bar next to the title.
fun setOnItemViewClickedListener(listener: OnItemViewClickedListener!): Unit
Sets an item clicked listener for the results.
| Parameters | |
|---|---|
listener: OnItemViewClickedListener! |
The item clicked listener to be invoked when an item in the search results is clicked. |
fun setOnItemViewSelectedListener(listener: OnItemViewSelectedListener!): Unit
Sets an item selection listener for the results.
| Parameters | |
|---|---|
listener: OnItemViewSelectedListener! |
The item selection listener to be invoked when an item in the search results is selected. |
fun setSearchAffordanceColors(colors: SearchOrbView.Colors!): Unit
Sets background color of not-listening state search orb.
| Parameters | |
|---|---|
colors: SearchOrbView.Colors! |
SearchOrbView.Colors. |
fun setSearchAffordanceColorsInListening(colors: SearchOrbView.Colors!): Unit
Sets background color of listening state search orb.
| Parameters | |
|---|---|
colors: SearchOrbView.Colors! |
SearchOrbView.Colors. |
fun setSearchQuery(intent: Intent!, submit: Boolean): Unit
Sets the text of the search query based on the EXTRA_RESULTS in the given intent, and optionally submit the query. If more than one result is present in the results list, the first will be used.
fun setSearchQuery(query: String!, submit: Boolean): Unit
Sets the text of the search query and optionally submits the query. Either onQueryTextChange or onQueryTextSubmit will be called on the provider if it is set.
fun setSearchResultProvider(
searchResultProvider: SearchFragment.SearchResultProvider!
): Unit
Sets the search provider that is responsible for returning results for the search query.
funsetSpeechRecognitionCallback(callback: SpeechRecognitionCallback!): Unit
Sets this callback to have the fragment pass speech recognition requests to the activity rather than using a SpeechRecognizer object.
fun setTitle(title: String!): Unit
Sets the title string to be be shown in an empty search bar. The title may be placed in a call-to-action, such as "Search title" or "Speak to search title".
fun startRecognition(): Unit
Starts speech recognition. Typical use case is that activity receives onNewIntent() call when user clicks a MIC button. Note that SearchFragment automatically starts speech recognition at first time created, there is no need to call startRecognition() when fragment is created.