# SearchFragment
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
Deprecated since version 27.1.0
Summary:[Nested Classes](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#nestedclasses)\|[Inherited Constants](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#inhconstants)\|[Ctors](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#)
# SearchFragment
| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).
`
public
class
SearchFragment
`
`
``
extends `[Fragment](https://developer.android.com/reference/android/app/Fragment.html)`
``
`
|---|---|-------------------------------------------------|
| java.lang.Object |||
| ↳ | [android.app.Fragment](https://developer.android.com/reference/android/app/Fragment.html) ||
| | ↳ | android.support.v17.leanback.app.SearchFragment |
*** ** * ** ***
**This class was deprecated in API level 27.1.0.**
use[SearchSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment)
A fragment to handle searches. An application will supply an implementation of the[SearchFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment.SearchResultProvider)interface to handle the search and return an[ObjectAdapter](https://developer.android.com/reference/android/support/v17/leanback/widget/ObjectAdapter)containing the results. The results are rendered into a[RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment), in the same way that they are in a[BrowseFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment).
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(SpeechRecognitionCallback)](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setSpeechRecognitionCallback(android.support.v17.leanback.widget.SpeechRecognitionCallback))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()](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#startRecognition()), typically in onNewIntent().
## Summary
| ### Nested classes ||
|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` interface` | [SearchFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment.SearchResultProvider) Search API to be provided by the application. |
| ### Inherited constants |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#)From interface` android.content.ComponentCallbacks2 ` |-------|---------------------------------------| | `int` | `TRIM_MEMORY_BACKGROUND`
| | `int` | `TRIM_MEMORY_COMPLETE`
| | `int` | `TRIM_MEMORY_MODERATE`
| | `int` | `TRIM_MEMORY_RUNNING_CRITICAL`
| | `int` | `TRIM_MEMORY_RUNNING_LOW`
| | `int` | `TRIM_MEMORY_RUNNING_MODERATE`
| | `int` | `TRIM_MEMORY_UI_HIDDEN`
| |
| ### Public constructors ||
|------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[SearchFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#SearchFragment())`() ` |
| ### Public methods ||
|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` static `[Bundle](https://developer.android.com/reference/android/os/Bundle.html) | ` `[createArgs](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#createArgs(android.os.Bundle, java.lang.String, java.lang.String))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` args, String query, String title) ` |
| ` static `[Bundle](https://developer.android.com/reference/android/os/Bundle.html) | ` `[createArgs](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#createArgs(android.os.Bundle, java.lang.String))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` args, String query) ` |
| ` void` | ` `[displayCompletions](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#displayCompletions(android.view.inputmethod.CompletionInfo[]))`(`[CompletionInfo[]](https://developer.android.com/reference/android/view/inputmethod/CompletionInfo.html)` completions) ` Displays the completions shown by the IME. |
| ` void` | ` `[displayCompletions](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#displayCompletions(java.util.List))`(List completions) ` Displays the completions shown by the IME. |
| ` `[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html) | ` `[getBadgeDrawable](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#getBadgeDrawable())`() ` Returns the badge drawable in the search bar. |
| ` `[Intent](https://developer.android.com/reference/android/content/Intent.html) | ` `[getRecognizerIntent](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#getRecognizerIntent())`() ` Returns an intent that can be used to request speech recognition. |
| ` `[RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment) | ` `[getRowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#getRowsFragment())`() ` Returns RowsFragment that shows result rows. |
| ` String` | ` `[getTitle](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#getTitle())`() ` Returns the title set in the search bar. |
| ` static `[SearchFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment) | ` `[newInstance](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#newInstance(java.lang.String))`(String query) ` Creates a search fragment with a given search query. |
| ` void` | ` `[onCreate](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#onCreate(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` |
| ` `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateView](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))`(`[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)` inflater, `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` container, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` |
| ` void` | ` `[onDestroy](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#onDestroy())`() ` |
| ` void` | ` `[onPause](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#onPause())`() ` |
| ` void` | ` `[onRequestPermissionsResult](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#onRequestPermissionsResult(int, java.lang.String[], int[]))`(int requestCode, String[] permissions, int[] grantResults) ` |
| ` void` | ` `[onResume](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#onResume())`() ` |
| ` void` | ` `[onStart](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#onStart())`() ` |
| ` void` | ` `[setBadgeDrawable](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setBadgeDrawable(android.graphics.drawable.Drawable))`(`[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)` drawable) ` Sets the badge drawable that will be shown inside the search bar next to the title. |
| ` void` | ` `[setOnItemViewClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setOnItemViewClickedListener(android.support.v17.leanback.widget.OnItemViewClickedListener))`(`[OnItemViewClickedListener](https://developer.android.com/reference/android/support/v17/leanback/widget/OnItemViewClickedListener)` listener) ` Sets an item clicked listener for the results. |
| ` void` | ` `[setOnItemViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setOnItemViewSelectedListener(android.support.v17.leanback.widget.OnItemViewSelectedListener))`(`[OnItemViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/widget/OnItemViewSelectedListener)` listener) ` Sets an item selection listener for the results. |
| ` void` | ` `[setSearchAffordanceColors](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setSearchAffordanceColors(android.support.v17.leanback.widget.SearchOrbView.Colors))`(`[SearchOrbView.Colors](https://developer.android.com/reference/android/support/v17/leanback/widget/SearchOrbView.Colors)` colors) ` Sets background color of not-listening state search orb. |
| ` void` | ` `[setSearchAffordanceColorsInListening](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setSearchAffordanceColorsInListening(android.support.v17.leanback.widget.SearchOrbView.Colors))`(`[SearchOrbView.Colors](https://developer.android.com/reference/android/support/v17/leanback/widget/SearchOrbView.Colors)` colors) ` Sets background color of listening state search orb. |
| ` void` | ` `[setSearchQuery](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setSearchQuery(java.lang.String, boolean))`(String query, boolean submit) ` Sets the text of the search query and optionally submits the query. |
| ` void` | ` `[setSearchQuery](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setSearchQuery(android.content.Intent, boolean))`(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` intent, boolean submit) ` Sets the text of the search query based on the[EXTRA_RESULTS](https://developer.android.com/reference/android/speech/RecognizerIntent.html#EXTRA_RESULTS)in the given intent, and optionally submit the query. |
| ` void` | ` `[setSearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setSearchResultProvider(android.support.v17.leanback.app.SearchFragment.SearchResultProvider))`(`[SearchFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment.SearchResultProvider)` searchResultProvider) ` Sets the search provider that is responsible for returning results for the search query. |
| ` void` | ` `[setSpeechRecognitionCallback](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setSpeechRecognitionCallback(android.support.v17.leanback.widget.SpeechRecognitionCallback))`(`[SpeechRecognitionCallback](https://developer.android.com/reference/android/support/v17/leanback/widget/SpeechRecognitionCallback)` callback) ` *This method was deprecated in API level 27.1.0. Launching voice recognition activity is no longer supported. App should declare android.permission.RECORD_AUDIO in AndroidManifest file.* |
| ` void` | ` `[setTitle](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setTitle(java.lang.String))`(String title) ` Sets the title string to be be shown in an empty search bar. |
| ` void` | ` `[startRecognition](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#startRecognition())`() ` Starts speech recognition. |
| ### Inherited methods |
|-----------------------|---|
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#)From class` `[android.app.Fragment](https://developer.android.com/reference/android/app/Fragment.html)` ` |------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3) ` | | ` final boolean` | ` equals(Object arg0) ` | | ` final `[Activity](https://developer.android.com/reference/android/app/Activity.html) | ` getActivity() ` | | ` boolean` | ` getAllowEnterTransitionOverlap() ` | | ` boolean` | ` getAllowReturnTransitionOverlap() ` | | ` final `[Bundle](https://developer.android.com/reference/android/os/Bundle.html) | ` getArguments() ` | | ` final `[FragmentManager](https://developer.android.com/reference/android/app/FragmentManager.html) | ` getChildFragmentManager() ` | | ` `[Context](https://developer.android.com/reference/android/content/Context.html) | ` getContext() ` | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html) | ` getEnterTransition() ` | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html) | ` getExitTransition() ` | | ` final `[FragmentManager](https://developer.android.com/reference/android/app/FragmentManager.html) | ` getFragmentManager() ` | | ` final Object` | ` getHost() ` | | ` final int` | ` getId() ` | | ` final `[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html) | ` getLayoutInflater() ` | | ` `[LoaderManager](https://developer.android.com/reference/android/app/LoaderManager.html) | ` getLoaderManager() ` | | ` final `[Fragment](https://developer.android.com/reference/android/app/Fragment.html) | ` getParentFragment() ` | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html) | ` getReenterTransition() ` | | ` final `[Resources](https://developer.android.com/reference/android/content/res/Resources.html) | ` getResources() ` | | ` final boolean` | ` getRetainInstance() ` | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html) | ` getReturnTransition() ` | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html) | ` getSharedElementEnterTransition() ` | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html) | ` getSharedElementReturnTransition() ` | | ` final String` | ` getString(int arg0, Object... arg1) ` | | ` final String` | ` getString(int arg0) ` | | ` final String` | ` getTag() ` | | ` final `[Fragment](https://developer.android.com/reference/android/app/Fragment.html) | ` getTargetFragment() ` | | ` final int` | ` getTargetRequestCode() ` | | ` final CharSequence` | ` getText(int arg0) ` | | ` boolean` | ` getUserVisibleHint() ` | | ` `[View](https://developer.android.com/reference/android/view/View.html) | ` getView() ` | | ` final int` | ` hashCode() ` | | ` static `[Fragment](https://developer.android.com/reference/android/app/Fragment.html) | ` instantiate(`[Context](https://developer.android.com/reference/android/content/Context.html)` arg0, String arg1) ` | | ` static `[Fragment](https://developer.android.com/reference/android/app/Fragment.html) | ` instantiate(`[Context](https://developer.android.com/reference/android/content/Context.html)` arg0, String arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg2) ` | | ` final boolean` | ` isAdded() ` | | ` final boolean` | ` isDetached() ` | | ` final boolean` | ` isHidden() ` | | ` final boolean` | ` isInLayout() ` | | ` final boolean` | ` isRemoving() ` | | ` final boolean` | ` isResumed() ` | | ` final boolean` | ` isStateSaved() ` | | ` final boolean` | ` isVisible() ` | | ` void` | ` onActivityCreated(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) ` | | ` void` | ` onActivityResult(int arg0, int arg1, `[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg2) ` | | ` void` | ` onAttach(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` arg0) ` | | ` void` | ` onAttach(`[Context](https://developer.android.com/reference/android/content/Context.html)` arg0) ` | | ` void` | ` onAttachFragment(`[Fragment](https://developer.android.com/reference/android/app/Fragment.html)` arg0) ` | | ` void` | ` onConfigurationChanged(`[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` arg0) ` | | ` boolean` | ` onContextItemSelected(`[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)` arg0) ` | | ` void` | ` onCreate(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) ` | | ` `[Animator](https://developer.android.com/reference/android/animation/Animator.html) | ` onCreateAnimator(int arg0, boolean arg1, int arg2) ` | | ` void` | ` onCreateContextMenu(`[ContextMenu](https://developer.android.com/reference/android/view/ContextMenu.html)` arg0, `[View](https://developer.android.com/reference/android/view/View.html)` arg1, `[ContextMenu.ContextMenuInfo](https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html)` arg2) ` | | ` void` | ` onCreateOptionsMenu(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` arg0, `[MenuInflater](https://developer.android.com/reference/android/view/MenuInflater.html)` arg1) ` | | ` `[View](https://developer.android.com/reference/android/view/View.html) | ` onCreateView(`[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)` arg0, `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg2) ` | | ` void` | ` onDestroy() ` | | ` void` | ` onDestroyOptionsMenu() ` | | ` void` | ` onDestroyView() ` | | ` void` | ` onDetach() ` | | ` `[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html) | ` onGetLayoutInflater(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) ` | | ` void` | ` onHiddenChanged(boolean arg0) ` | | ` void` | ` onInflate(`[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` arg0, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg1) ` | | ` void` | ` onInflate(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` arg0, `[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg2) ` | | ` void` | ` onInflate(`[Context](https://developer.android.com/reference/android/content/Context.html)` arg0, `[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg2) ` | | ` void` | ` onLowMemory() ` | | ` void` | ` onMultiWindowModeChanged(boolean arg0) ` | | ` void` | ` onMultiWindowModeChanged(boolean arg0, `[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` arg1) ` | | ` boolean` | ` onOptionsItemSelected(`[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)` arg0) ` | | ` void` | ` onOptionsMenuClosed(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` arg0) ` | | ` void` | ` onPause() ` | | ` void` | ` onPictureInPictureModeChanged(boolean arg0, `[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` arg1) ` | | ` void` | ` onPictureInPictureModeChanged(boolean arg0) ` | | ` void` | ` onPrepareOptionsMenu(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` arg0) ` | | ` void` | ` onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2) ` | | ` void` | ` onResume() ` | | ` void` | ` onSaveInstanceState(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) ` | | ` void` | ` onStart() ` | | ` void` | ` onStop() ` | | ` void` | ` onTrimMemory(int arg0) ` | | ` void` | ` onViewCreated(`[View](https://developer.android.com/reference/android/view/View.html)` arg0, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg1) ` | | ` void` | ` onViewStateRestored(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) ` | | ` void` | ` postponeEnterTransition() ` | | ` void` | ` registerForContextMenu(`[View](https://developer.android.com/reference/android/view/View.html)` arg0) ` | | ` final void` | ` requestPermissions(String[] arg0, int arg1) ` | | ` void` | ` setAllowEnterTransitionOverlap(boolean arg0) ` | | ` void` | ` setAllowReturnTransitionOverlap(boolean arg0) ` | | ` void` | ` setArguments(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) ` | | ` void` | ` setEnterSharedElementCallback(`[SharedElementCallback](https://developer.android.com/reference/android/app/SharedElementCallback.html)` arg0) ` | | ` void` | ` setEnterTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) ` | | ` void` | ` setExitSharedElementCallback(`[SharedElementCallback](https://developer.android.com/reference/android/app/SharedElementCallback.html)` arg0) ` | | ` void` | ` setExitTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) ` | | ` void` | ` setHasOptionsMenu(boolean arg0) ` | | ` void` | ` setInitialSavedState(`[Fragment.SavedState](https://developer.android.com/reference/android/app/Fragment.SavedState.html)` arg0) ` | | ` void` | ` setMenuVisibility(boolean arg0) ` | | ` void` | ` setReenterTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) ` | | ` void` | ` setRetainInstance(boolean arg0) ` | | ` void` | ` setReturnTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) ` | | ` void` | ` setSharedElementEnterTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) ` | | ` void` | ` setSharedElementReturnTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) ` | | ` void` | ` setTargetFragment(`[Fragment](https://developer.android.com/reference/android/app/Fragment.html)` arg0, int arg1) ` | | ` void` | ` setUserVisibleHint(boolean arg0) ` | | ` boolean` | ` shouldShowRequestPermissionRationale(String arg0) ` | | ` void` | ` startActivity(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg0) ` | | ` void` | ` startActivity(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg0, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg1) ` | | ` void` | ` startActivityForResult(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg0, int arg1) ` | | ` void` | ` startActivityForResult(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg0, int arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg2) ` | | ` void` | ` startIntentSenderForResult(`[IntentSender](https://developer.android.com/reference/android/content/IntentSender.html)` arg0, int arg1, `[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg2, int arg3, int arg4, int arg5, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg6) ` | | ` void` | ` startPostponedEnterTransition() ` | | ` String` | ` toString() ` | | ` void` | ` unregisterForContextMenu(`[View](https://developer.android.com/reference/android/view/View.html)` arg0) ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#)From interface` `[android.content.ComponentCallbacks2](https://developer.android.com/reference/android/content/ComponentCallbacks2.html)` ` |------------------|----------------------------| | ` abstract void` | ` onTrimMemory(int arg0) ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#)From interface` `[android.view.View.OnCreateContextMenuListener](https://developer.android.com/reference/android/view/View.OnCreateContextMenuListener.html)` ` |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` onCreateContextMenu(`[ContextMenu](https://developer.android.com/reference/android/view/ContextMenu.html)` arg0, `[View](https://developer.android.com/reference/android/view/View.html)` arg1, `[ContextMenu.ContextMenuInfo](https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html)` arg2) ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#)From interface` `[android.content.ComponentCallbacks](https://developer.android.com/reference/android/content/ComponentCallbacks.html)` ` |------------------|------------------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` onConfigurationChanged(`[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` arg0) ` | | ` abstract void` | ` onLowMemory() ` | ||
## Public constructors
### SearchFragment
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
SearchFragment ()
```
## Public methods
### createArgs
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
Bundle createArgs (Bundle args,
String query,
String title)
```
| Parameters ||
|---------|-----------------|
| `args` | `Bundle`
|
| `query` | `String`
|
| `title` | `String`
|
| Returns ||
|--------------------------------------------------------------------------|--------|
| [Bundle](https://developer.android.com/reference/android/os/Bundle.html) |
|
### createArgs
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
Bundle createArgs (Bundle args,
String query)
```
| Parameters ||
|---------|-----------------------------------------------------------------------------------------|
| `args` | `Bundle`: Bundle to use for the arguments, if null a new Bundle will be created.
|
| `query` | `String`
|
| Returns ||
|--------------------------------------------------------------------------|--------|
| [Bundle](https://developer.android.com/reference/android/os/Bundle.html) |
|
### displayCompletions
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void displayCompletions (CompletionInfo[] completions)
```
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` | `CompletionInfo`: A list of completions to show in the IME. Setting to null or empty will clear the list.
|
### displayCompletions
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void displayCompletions (List completions)
```
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` | `List`: A list of completions to show in the IME. Setting to null or empty will clear the list.
|
### getBadgeDrawable
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
Drawable getBadgeDrawable ()
```
Returns the badge drawable in the search bar.
| Returns ||
|---------------------------------------------------------------------------------------------|--------|
| [Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html) |
|
### getRecognizerIntent
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
Intent getRecognizerIntent ()
```
Returns an intent that can be used to request speech recognition. Built from the base[ACTION_RECOGNIZE_SPEECH](https://developer.android.com/reference/android/speech/RecognizerIntent.html#ACTION_RECOGNIZE_SPEECH)plus extras:
- [EXTRA_LANGUAGE_MODEL](https://developer.android.com/reference/android/speech/RecognizerIntent.html#EXTRA_LANGUAGE_MODEL)set to[LANGUAGE_MODEL_FREE_FORM](https://developer.android.com/reference/android/speech/RecognizerIntent.html#LANGUAGE_MODEL_FREE_FORM)
- [EXTRA_PARTIAL_RESULTS](https://developer.android.com/reference/android/speech/RecognizerIntent.html#EXTRA_PARTIAL_RESULTS)set to true
- [EXTRA_PROMPT](https://developer.android.com/reference/android/speech/RecognizerIntent.html#EXTRA_PROMPT)set to the search bar hint text
For handling the intent returned from the service, see[setSearchQuery(Intent, boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment#setSearchQuery(android.content.Intent, boolean)).
| Returns ||
|-------------------------------------------------------------------------------|--------|
| [Intent](https://developer.android.com/reference/android/content/Intent.html) |
|
### getRowsFragment
added in[version 25.4.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
RowsFragment getRowsFragment ()
```
Returns RowsFragment that shows result rows. RowsFragment is initialized after SearchFragment.onCreateView().
| Returns ||
|-------------------------------------------------------------------------------------------------------|---------------------------------------------|
| [RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment) | RowsFragment that shows result rows.
|
### getTitle
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
String getTitle ()
```
Returns the title set in the search bar.
| Returns ||
|----------|--------|
| `String` |
|
### newInstance
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
SearchFragment newInstance (String query)
```
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](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment) | A new SearchFragment.
|
### onCreate
```
void onCreate (Bundle savedInstanceState)
```
| Parameters ||
|----------------------|-----------------|
| `savedInstanceState` | `Bundle`
|
### onCreateView
```
View onCreateView (LayoutInflater inflater,
ViewGroup container,
Bundle savedInstanceState)
```
| Parameters ||
|----------------------|-------------------------|
| `inflater` | `LayoutInflater`
|
| `container` | `ViewGroup`
|
| `savedInstanceState` | `Bundle`
|
| Returns ||
|------------------------------------------------------------------------|--------|
| [View](https://developer.android.com/reference/android/view/View.html) |
|
### onDestroy
```
void onDestroy ()
```
### onPause
```
void onPause ()
```
### onRequestPermissionsResult
```
void onRequestPermissionsResult (int requestCode,
String[] permissions,
int[] grantResults)
```
| Parameters ||
|----------------|-----------------|
| `requestCode` | `int`
|
| `permissions` | `String`
|
| `grantResults` | `int`
|
### onResume
```
void onResume ()
```
### onStart
```
void onStart ()
```
### setBadgeDrawable
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setBadgeDrawable (Drawable drawable)
```
Sets the badge drawable that will be shown inside the search bar next to the title.
| Parameters ||
|------------|-------------------|
| `drawable` | `Drawable`
|
### setOnItemViewClickedListener
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setOnItemViewClickedListener (OnItemViewClickedListener listener)
```
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.
|
### setOnItemViewSelectedListener
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setOnItemViewSelectedListener (OnItemViewSelectedListener listener)
```
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.
|
### setSearchAffordanceColors
added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setSearchAffordanceColors (SearchOrbView.Colors colors)
```
Sets background color of not-listening state search orb.
| Parameters ||
|----------|------------------------------------------------------|
| `colors` | `SearchOrbView.Colors`: SearchOrbView.Colors.
|
### setSearchAffordanceColorsInListening
added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setSearchAffordanceColorsInListening (SearchOrbView.Colors colors)
```
Sets background color of listening state search orb.
| Parameters ||
|----------|------------------------------------------------------|
| `colors` | `SearchOrbView.Colors`: SearchOrbView.Colors.
|
### setSearchQuery
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setSearchQuery (String query,
boolean submit)
```
Sets the text of the search query and optionally submits the query. Either[onQueryTextChange](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment.SearchResultProvider#onQueryTextChange(java.lang.String))or[onQueryTextSubmit](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment.SearchResultProvider#onQueryTextSubmit(java.lang.String))will be called on the provider if it is set.
| Parameters ||
|----------|------------------------------------------------|
| `query` | `String`: The search query to set.
|
| `submit` | `boolean`: Whether to submit the query.
|
### setSearchQuery
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setSearchQuery (Intent intent,
boolean submit)
```
Sets the text of the search query based on the[EXTRA_RESULTS](https://developer.android.com/reference/android/speech/RecognizerIntent.html#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.
| Parameters ||
|----------|---------------------------------------------------------------------|
| `intent` | `Intent`: Intent received from a speech recognition service.
|
| `submit` | `boolean`: Whether to submit the query.
|
### setSearchResultProvider
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setSearchResultProvider (SearchFragment.SearchResultProvider searchResultProvider)
```
Sets the search provider that is responsible for returning results for the search query.
| Parameters ||
|------------------------|----------------------------------------------|
| `searchResultProvider` | `SearchFragment.SearchResultProvider`
|
### setSpeechRecognitionCallback
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setSpeechRecognitionCallback (SpeechRecognitionCallback callback)
```
**This method was deprecated in API level 27.1.0.**
Launching voice recognition activity is no longer supported. App should declare android.permission.RECORD_AUDIO in AndroidManifest file.
Sets this callback to have the fragment pass speech recognition requests to the activity rather than using a SpeechRecognizer object.
| Parameters ||
|------------|------------------------------------|
| `callback` | `SpeechRecognitionCallback`
|
### setTitle
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void setTitle (String title)
```
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*".
| Parameters ||
|---------|-----------------|
| `title` | `String`
|
### startRecognition
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void startRecognition ()
```
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.
-
## Interfaces
- [BrowseFragment.FragmentHost](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.FragmentHost)
- [BrowseFragment.MainFragmentAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapterProvider)
- [BrowseFragment.MainFragmentRowsAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentRowsAdapterProvider)
- [BrowseSupportFragment.FragmentHost](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.FragmentHost)
- [BrowseSupportFragment.MainFragmentAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapterProvider)
- [BrowseSupportFragment.MainFragmentRowsAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentRowsAdapterProvider)
- [HeadersFragment.OnHeaderClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment.OnHeaderClickedListener)
- [HeadersFragment.OnHeaderViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment.OnHeaderViewSelectedListener)
- [HeadersSupportFragment.OnHeaderClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment.OnHeaderClickedListener)
- [HeadersSupportFragment.OnHeaderViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment.OnHeaderViewSelectedListener)
- [SearchFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment.SearchResultProvider)
- [SearchSupportFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment.SearchResultProvider)
-
## Classes
- [BackgroundManager](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager)
- [BaseFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BaseFragment)
- [BaseSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BaseSupportFragment)
- [BrandedFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrandedFragment)
- [BrandedSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrandedSupportFragment)
- [BrowseFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment)
- [BrowseFragment.BrowseTransitionListener](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.BrowseTransitionListener)
- [BrowseFragment.FragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.FragmentFactory)
- [BrowseFragment.ListRowFragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.ListRowFragmentFactory)
- [BrowseFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapter)
- [BrowseFragment.MainFragmentAdapterRegistry](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapterRegistry)
- [BrowseFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentRowsAdapter)
- [BrowseSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment)
- [BrowseSupportFragment.BrowseTransitionListener](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.BrowseTransitionListener)
- [BrowseSupportFragment.FragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.FragmentFactory)
- [BrowseSupportFragment.ListRowFragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.ListRowFragmentFactory)
- [BrowseSupportFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapter)
- [BrowseSupportFragment.MainFragmentAdapterRegistry](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapterRegistry)
- [BrowseSupportFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentRowsAdapter)
- [DetailsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsFragment)
- [DetailsFragmentBackgroundController](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsFragmentBackgroundController)
- [DetailsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsSupportFragment)
- [DetailsSupportFragmentBackgroundController](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsSupportFragmentBackgroundController)
- [ErrorFragment](https://developer.android.com/reference/android/support/v17/leanback/app/ErrorFragment)
- [ErrorSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/ErrorSupportFragment)
- [GuidedStepFragment](https://developer.android.com/reference/android/support/v17/leanback/app/GuidedStepFragment)
- [GuidedStepSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/GuidedStepSupportFragment)
- [HeadersFragment](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment)
- [HeadersSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment)
- [OnboardingFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingFragment)
- [OnboardingSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment)
- [PlaybackFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment)
- [PlaybackFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragmentGlueHost)
- [PlaybackSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackSupportFragment)
- [PlaybackSupportFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackSupportFragmentGlueHost)
- [ProgressBarManager](https://developer.android.com/reference/android/support/v17/leanback/app/ProgressBarManager)
- [RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment)
- [RowsFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment.MainFragmentAdapter)
- [RowsFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment.MainFragmentRowsAdapter)
- [RowsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment)
- [RowsSupportFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment.MainFragmentAdapter)
- [RowsSupportFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment.MainFragmentRowsAdapter)
- [SearchFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment)
- [SearchSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment)
- [VerticalGridFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VerticalGridFragment)
- [VerticalGridSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VerticalGridSupportFragment)
- [VideoFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragment)
- [VideoFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragmentGlueHost)
- [VideoSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoSupportFragment)
- [VideoSupportFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/VideoSupportFragmentGlueHost)