# SearchSupportFragment
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
Summary:[Nested Classes](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#nestedclasses)\|[Ctors](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#)
# SearchSupportFragment
| 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
SearchSupportFragment
`
`
``
extends `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment)`
``
`
|---|---|--------------------------------------------------------|
| java.lang.Object |||
| ↳ | [android.support.v4.app.Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) ||
| | ↳ | android.support.v17.leanback.app.SearchSupportFragment |
*** ** * ** ***
A fragment to handle searches. An application will supply an implementation of the[SearchSupportFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment.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[RowsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment), in the same way that they are in a[BrowseSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment).
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/SearchSupportFragment#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/SearchSupportFragment#startRecognition()), typically in onNewIntent().
## Summary
| ### Nested classes ||
|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` interface` | [SearchSupportFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment.SearchResultProvider) Search API to be provided by the application. |
| ### Public constructors ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[SearchSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#SearchSupportFragment())`() ` |
| ### Public methods ||
|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` static `[Bundle](https://developer.android.com/reference/android/os/Bundle.html) | ` `[createArgs](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#getRecognizerIntent())`() ` Returns an intent that can be used to request speech recognition. |
| ` `[RowsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment) | ` `[getRowsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#getRowsSupportFragment())`() ` Returns RowsSupportFragment that shows result rows. |
| ` String` | ` `[getTitle](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#getTitle())`() ` Returns the title set in the search bar. |
| ` static `[SearchSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment) | ` `[newInstance](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#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/SearchSupportFragment#onCreate(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called to do initial creation of a fragment. |
| ` `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateView](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#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) ` Called to have the fragment instantiate its user interface view. |
| ` void` | ` `[onDestroy](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#onDestroy())`() ` Called when the fragment is no longer in use. |
| ` void` | ` `[onPause](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#onPause())`() ` Called when the Fragment is no longer resumed. |
| ` void` | ` `[onRequestPermissionsResult](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#onRequestPermissionsResult(int, java.lang.String[], int[]))`(int requestCode, String[] permissions, int[] grantResults) ` Callback for the result from requesting permissions. |
| ` void` | ` `[onResume](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#onResume())`() ` Called when the fragment is visible to the user and actively running. |
| ` void` | ` `[onStart](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#onStart())`() ` Called when the Fragment is visible to the user. |
| ` void` | ` `[setBadgeDrawable](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#setSearchResultProvider(android.support.v17.leanback.app.SearchSupportFragment.SearchResultProvider))`(`[SearchSupportFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment.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/SearchSupportFragment#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/SearchSupportFragment#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/SearchSupportFragment#startRecognition())`() ` Starts speech recognition. |
| ### Inherited methods |
|-----------------------|---|
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#)From class` `[android.support.v4.app.Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment)` ` |--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` `[dump](https://developer.android.com/reference/android/support/v4/app/Fragment#dump(java.lang.String, java.io.FileDescriptor, java.io.PrintWriter, java.lang.String[]))`(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) ` Print the Fragments's state into the given stream. | | ` final boolean` | ` `[equals](https://developer.android.com/reference/android/support/v4/app/Fragment#equals(java.lang.Object))`(Object o) ` Subclasses can not override equals(). | | ` final `[FragmentActivity](https://developer.android.com/reference/android/support/v4/app/FragmentActivity) | ` `[getActivity](https://developer.android.com/reference/android/support/v4/app/Fragment#getActivity())`() ` Return the[FragmentActivity](https://developer.android.com/reference/android/support/v4/app/FragmentActivity)this fragment is currently associated with. | | ` boolean` | ` `[getAllowEnterTransitionOverlap](https://developer.android.com/reference/android/support/v4/app/Fragment#getAllowEnterTransitionOverlap())`() ` Returns whether the the exit transition and enter transition overlap or not. | | ` boolean` | ` `[getAllowReturnTransitionOverlap](https://developer.android.com/reference/android/support/v4/app/Fragment#getAllowReturnTransitionOverlap())`() ` Returns whether the the return transition and reenter transition overlap or not. | | ` final `[Bundle](https://developer.android.com/reference/android/os/Bundle.html) | ` `[getArguments](https://developer.android.com/reference/android/support/v4/app/Fragment#getArguments())`() ` Return the arguments supplied when the fragment was instantiated, if any. | | ` final `[FragmentManager](https://developer.android.com/reference/android/support/v4/app/FragmentManager) | ` `[getChildFragmentManager](https://developer.android.com/reference/android/support/v4/app/Fragment#getChildFragmentManager())`() ` Return a private FragmentManager for placing and managing Fragments inside of this Fragment. | | ` `[Context](https://developer.android.com/reference/android/content/Context.html) | ` `[getContext](https://developer.android.com/reference/android/support/v4/app/Fragment#getContext())`() ` Return the[Context](https://developer.android.com/reference/android/content/Context.html)this fragment is currently associated with. | | ` Object` | ` `[getEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getEnterTransition())`() ` Returns the Transition that will be used to move Views into the initial scene. | | ` Object` | ` `[getExitTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getExitTransition())`() ` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. | | ` final `[FragmentManager](https://developer.android.com/reference/android/support/v4/app/FragmentManager) | ` `[getFragmentManager](https://developer.android.com/reference/android/support/v4/app/Fragment#getFragmentManager())`() ` Return the FragmentManager for interacting with fragments associated with this fragment's activity. | | ` final Object` | ` `[getHost](https://developer.android.com/reference/android/support/v4/app/Fragment#getHost())`() ` Return the host object of this fragment. | | ` final int` | ` `[getId](https://developer.android.com/reference/android/support/v4/app/Fragment#getId())`() ` Return the identifier this fragment is known by. | | ` final `[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html) | ` `[getLayoutInflater](https://developer.android.com/reference/android/support/v4/app/Fragment#getLayoutInflater())`() ` Returns the cached LayoutInflater used to inflate Views of this Fragment. | | ` Lifecycle` | ` `[getLifecycle](https://developer.android.com/reference/android/support/v4/app/Fragment#getLifecycle())`() ` | | ` `[LoaderManager](https://developer.android.com/reference/android/support/v4/app/LoaderManager) | ` `[getLoaderManager](https://developer.android.com/reference/android/support/v4/app/Fragment#getLoaderManager())`() ` Return the LoaderManager for this fragment. | | ` final `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) | ` `[getParentFragment](https://developer.android.com/reference/android/support/v4/app/Fragment#getParentFragment())`() ` Returns the parent Fragment containing this Fragment. | | ` Object` | ` `[getReenterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getReenterTransition())`() ` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. | | ` final `[Resources](https://developer.android.com/reference/android/content/res/Resources.html) | ` `[getResources](https://developer.android.com/reference/android/support/v4/app/Fragment#getResources())`() ` Return`requireActivity().getResources()`. | | ` final boolean` | ` `[getRetainInstance](https://developer.android.com/reference/android/support/v4/app/Fragment#getRetainInstance())`() ` | | ` Object` | ` `[getReturnTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getReturnTransition())`() ` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. | | ` Object` | ` `[getSharedElementEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getSharedElementEnterTransition())`() ` Returns the Transition that will be used for shared elements transferred into the content Scene. | | ` Object` | ` `[getSharedElementReturnTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#getSharedElementReturnTransition())`() ` Return the Transition that will be used for shared elements transferred back during a pop of the back stack. | | ` final String` | ` `[getString](https://developer.android.com/reference/android/support/v4/app/Fragment#getString(int, java.lang.Object...))`(int resId, Object... formatArgs) ` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in[Formatter](https://developer.android.com/reference/java/util/Formatter)and[format(String, Object...)](https://developer.android.com/reference/java/lang/String#format(java.lang.String, java.lang.Object...)). | | ` final String` | ` `[getString](https://developer.android.com/reference/android/support/v4/app/Fragment#getString(int))`(int resId) ` Return a localized string from the application's package's default string table. | | ` final String` | ` `[getTag](https://developer.android.com/reference/android/support/v4/app/Fragment#getTag())`() ` Get the tag name of the fragment, if specified. | | ` final `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) | ` `[getTargetFragment](https://developer.android.com/reference/android/support/v4/app/Fragment#getTargetFragment())`() ` Return the target fragment set by[setTargetFragment(Fragment, int)](https://developer.android.com/reference/android/support/v4/app/Fragment#setTargetFragment(android.support.v4.app.Fragment, int)). | | ` final int` | ` `[getTargetRequestCode](https://developer.android.com/reference/android/support/v4/app/Fragment#getTargetRequestCode())`() ` Return the target request code set by[setTargetFragment(Fragment, int)](https://developer.android.com/reference/android/support/v4/app/Fragment#setTargetFragment(android.support.v4.app.Fragment, int)). | | ` final CharSequence` | ` `[getText](https://developer.android.com/reference/android/support/v4/app/Fragment#getText(int))`(int resId) ` Return a localized, styled CharSequence from the application's package's default string table. | | ` boolean` | ` `[getUserVisibleHint](https://developer.android.com/reference/android/support/v4/app/Fragment#getUserVisibleHint())`() ` | | ` `[View](https://developer.android.com/reference/android/view/View.html) | ` `[getView](https://developer.android.com/reference/android/support/v4/app/Fragment#getView())`() ` Get the root view for the fragment's layout (the one returned by[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))), if provided. | | ` ViewModelStore` | ` `[getViewModelStore](https://developer.android.com/reference/android/support/v4/app/Fragment#getViewModelStore())`() ` | | ` final int` | ` `[hashCode](https://developer.android.com/reference/android/support/v4/app/Fragment#hashCode())`() ` Subclasses can not override hashCode(). | | ` static `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) | ` `[instantiate](https://developer.android.com/reference/android/support/v4/app/Fragment#instantiate(android.content.Context, java.lang.String))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context, String fname) ` Like[instantiate(Context, String, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#instantiate(android.content.Context, java.lang.String, android.os.Bundle))but with a null argument Bundle. | | ` static `[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment) | ` `[instantiate](https://developer.android.com/reference/android/support/v4/app/Fragment#instantiate(android.content.Context, java.lang.String, android.os.Bundle))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context, String fname, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` args) ` Create a new instance of a Fragment with the given class name. | | ` final boolean` | ` `[isAdded](https://developer.android.com/reference/android/support/v4/app/Fragment#isAdded())`() ` Return true if the fragment is currently added to its activity. | | ` final boolean` | ` `[isDetached](https://developer.android.com/reference/android/support/v4/app/Fragment#isDetached())`() ` Return true if the fragment has been explicitly detached from the UI. | | ` final boolean` | ` `[isHidden](https://developer.android.com/reference/android/support/v4/app/Fragment#isHidden())`() ` Return true if the fragment has been hidden. | | ` final boolean` | ` `[isInLayout](https://developer.android.com/reference/android/support/v4/app/Fragment#isInLayout())`() ` Return true if the layout is included as part of an activity view hierarchy via the \ tag. | | ` final boolean` | ` `[isRemoving](https://developer.android.com/reference/android/support/v4/app/Fragment#isRemoving())`() ` Return true if this fragment is currently being removed from its activity. | | ` final boolean` | ` `[isResumed](https://developer.android.com/reference/android/support/v4/app/Fragment#isResumed())`() ` Return true if the fragment is in the resumed state. | | ` final boolean` | ` `[isStateSaved](https://developer.android.com/reference/android/support/v4/app/Fragment#isStateSaved())`() ` Returns true if this fragment is added and its state has already been saved by its host. | | ` final boolean` | ` `[isVisible](https://developer.android.com/reference/android/support/v4/app/Fragment#isVisible())`() ` Return true if the fragment is currently visible to the user. | | ` void` | ` `[onActivityCreated](https://developer.android.com/reference/android/support/v4/app/Fragment#onActivityCreated(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. | | ` void` | ` `[onActivityResult](https://developer.android.com/reference/android/support/v4/app/Fragment#onActivityResult(int, int, android.content.Intent))`(int requestCode, int resultCode, `[Intent](https://developer.android.com/reference/android/content/Intent.html)` data) ` Receive the result from a previous call to[startActivityForResult(Intent, int)](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivityForResult(android.content.Intent, int)). | | ` void` | ` `[onAttach](https://developer.android.com/reference/android/support/v4/app/Fragment#onAttach(android.app.Activity))`(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` activity) ` *This method was deprecated in API level 24.1.0. See[onAttach(Context)](https://developer.android.com/reference/android/support/v4/app/Fragment#onAttach(android.content.Context)).* | | ` void` | ` `[onAttach](https://developer.android.com/reference/android/support/v4/app/Fragment#onAttach(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context) ` Called when a fragment is first attached to its context. | | ` void` | ` `[onAttachFragment](https://developer.android.com/reference/android/support/v4/app/Fragment#onAttachFragment(android.support.v4.app.Fragment))`(`[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment)` childFragment) ` Called when a fragment is attached as a child of this fragment. | | ` void` | ` `[onConfigurationChanged](https://developer.android.com/reference/android/support/v4/app/Fragment#onConfigurationChanged(android.content.res.Configuration))`(`[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` newConfig) ` | | ` boolean` | ` `[onContextItemSelected](https://developer.android.com/reference/android/support/v4/app/Fragment#onContextItemSelected(android.view.MenuItem))`(`[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)` item) ` This hook is called whenever an item in a context menu is selected. | | ` void` | ` `[onCreate](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreate(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called to do initial creation of a fragment. | | ` `[Animation](https://developer.android.com/reference/android/view/animation/Animation.html) | ` `[onCreateAnimation](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateAnimation(int, boolean, int))`(int transit, boolean enter, int nextAnim) ` Called when a fragment loads an animation. | | ` `[Animator](https://developer.android.com/reference/android/animation/Animator.html) | ` `[onCreateAnimator](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateAnimator(int, boolean, int))`(int transit, boolean enter, int nextAnim) ` Called when a fragment loads an animator. | | ` void` | ` `[onCreateContextMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateContextMenu(android.view.ContextMenu, android.view.View, android.view.ContextMenu.ContextMenuInfo))`(`[ContextMenu](https://developer.android.com/reference/android/view/ContextMenu.html)` menu, `[View](https://developer.android.com/reference/android/view/View.html)` v, `[ContextMenu.ContextMenuInfo](https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html)` menuInfo) ` Called when a context menu for the`view`is about to be shown. | | ` void` | ` `[onCreateOptionsMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateOptionsMenu(android.view.Menu, android.view.MenuInflater))`(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` menu, `[MenuInflater](https://developer.android.com/reference/android/view/MenuInflater.html)` inflater) ` Initialize the contents of the Fragment host's standard options menu. | | ` `[View](https://developer.android.com/reference/android/view/View.html) | ` `[onCreateView](https://developer.android.com/reference/android/support/v4/app/Fragment#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) ` Called to have the fragment instantiate its user interface view. | | ` void` | ` `[onDestroy](https://developer.android.com/reference/android/support/v4/app/Fragment#onDestroy())`() ` Called when the fragment is no longer in use. | | ` void` | ` `[onDestroyOptionsMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#onDestroyOptionsMenu())`() ` Called when this fragment's option menu items are no longer being included in the overall options menu. | | ` void` | ` `[onDestroyView](https://developer.android.com/reference/android/support/v4/app/Fragment#onDestroyView())`() ` Called when the view previously created by[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))has been detached from the fragment. | | ` void` | ` `[onDetach](https://developer.android.com/reference/android/support/v4/app/Fragment#onDetach())`() ` Called when the fragment is no longer attached to its activity. | | ` `[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html) | ` `[onGetLayoutInflater](https://developer.android.com/reference/android/support/v4/app/Fragment#onGetLayoutInflater(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Returns the LayoutInflater used to inflate Views of this Fragment. | | ` void` | ` `[onHiddenChanged](https://developer.android.com/reference/android/support/v4/app/Fragment#onHiddenChanged(boolean))`(boolean hidden) ` Called when the hidden state (as returned by[isHidden()](https://developer.android.com/reference/android/support/v4/app/Fragment#isHidden())of the fragment has changed. | | ` void` | ` `[onInflate](https://developer.android.com/reference/android/support/v4/app/Fragment#onInflate(android.app.Activity, android.util.AttributeSet, android.os.Bundle))`(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` activity, `[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` attrs, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` *This method was deprecated in API level 24.1.0. See[onInflate(Context, AttributeSet, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle)).* | | ` void` | ` `[onInflate](https://developer.android.com/reference/android/support/v4/app/Fragment#onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context, `[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` attrs, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity. | | ` void` | ` `[onLowMemory](https://developer.android.com/reference/android/support/v4/app/Fragment#onLowMemory())`() ` | | ` void` | ` `[onMultiWindowModeChanged](https://developer.android.com/reference/android/support/v4/app/Fragment#onMultiWindowModeChanged(boolean))`(boolean isInMultiWindowMode) ` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. | | ` boolean` | ` `[onOptionsItemSelected](https://developer.android.com/reference/android/support/v4/app/Fragment#onOptionsItemSelected(android.view.MenuItem))`(`[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)` item) ` This hook is called whenever an item in your options menu is selected. | | ` void` | ` `[onOptionsMenuClosed](https://developer.android.com/reference/android/support/v4/app/Fragment#onOptionsMenuClosed(android.view.Menu))`(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` menu) ` This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected). | | ` void` | ` `[onPause](https://developer.android.com/reference/android/support/v4/app/Fragment#onPause())`() ` Called when the Fragment is no longer resumed. | | ` void` | ` `[onPictureInPictureModeChanged](https://developer.android.com/reference/android/support/v4/app/Fragment#onPictureInPictureModeChanged(boolean))`(boolean isInPictureInPictureMode) ` Called by the system when the activity changes to and from picture-in-picture mode. | | ` void` | ` `[onPrepareOptionsMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#onPrepareOptionsMenu(android.view.Menu))`(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` menu) ` Prepare the Fragment host's standard options menu to be displayed. | | ` void` | ` `[onRequestPermissionsResult](https://developer.android.com/reference/android/support/v4/app/Fragment#onRequestPermissionsResult(int, java.lang.String[], int[]))`(int requestCode, String[] permissions, int[] grantResults) ` Callback for the result from requesting permissions. | | ` void` | ` `[onResume](https://developer.android.com/reference/android/support/v4/app/Fragment#onResume())`() ` Called when the fragment is visible to the user and actively running. | | ` void` | ` `[onSaveInstanceState](https://developer.android.com/reference/android/support/v4/app/Fragment#onSaveInstanceState(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` outState) ` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted. | | ` void` | ` `[onStart](https://developer.android.com/reference/android/support/v4/app/Fragment#onStart())`() ` Called when the Fragment is visible to the user. | | ` void` | ` `[onStop](https://developer.android.com/reference/android/support/v4/app/Fragment#onStop())`() ` Called when the Fragment is no longer started. | | ` void` | ` `[onViewCreated](https://developer.android.com/reference/android/support/v4/app/Fragment#onViewCreated(android.view.View, android.os.Bundle))`(`[View](https://developer.android.com/reference/android/view/View.html)` view, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called immediately after[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))has returned, but before any saved state has been restored in to the view. | | ` void` | ` `[onViewStateRestored](https://developer.android.com/reference/android/support/v4/app/Fragment#onViewStateRestored(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) ` Called when all saved state has been restored into the view hierarchy of the fragment. | | ` void` | ` `[postponeEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#postponeEnterTransition())`() ` Postpone the entering Fragment transition until[startPostponedEnterTransition()](https://developer.android.com/reference/android/support/v4/app/Fragment#startPostponedEnterTransition())or[executePendingTransactions()](https://developer.android.com/reference/android/support/v4/app/FragmentManager#executePendingTransactions())has been called. | | ` void` | ` `[registerForContextMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#registerForContextMenu(android.view.View))`(`[View](https://developer.android.com/reference/android/view/View.html)` view) ` Registers a context menu to be shown for the given view (multiple views can show the context menu). | | ` final void` | ` `[requestPermissions](https://developer.android.com/reference/android/support/v4/app/Fragment#requestPermissions(java.lang.String[], int))`(String[] permissions, int requestCode) ` Requests permissions to be granted to this application. | | ` final `[FragmentActivity](https://developer.android.com/reference/android/support/v4/app/FragmentActivity) | ` `[requireActivity](https://developer.android.com/reference/android/support/v4/app/Fragment#requireActivity())`() ` Return the[FragmentActivity](https://developer.android.com/reference/android/support/v4/app/FragmentActivity)this fragment is currently associated with. | | ` final `[Context](https://developer.android.com/reference/android/content/Context.html) | ` `[requireContext](https://developer.android.com/reference/android/support/v4/app/Fragment#requireContext())`() ` Return the[Context](https://developer.android.com/reference/android/content/Context.html)this fragment is currently associated with. | | ` final `[FragmentManager](https://developer.android.com/reference/android/support/v4/app/FragmentManager) | ` `[requireFragmentManager](https://developer.android.com/reference/android/support/v4/app/Fragment#requireFragmentManager())`() ` Return the FragmentManager for interacting with fragments associated with this fragment's activity. | | ` final Object` | ` `[requireHost](https://developer.android.com/reference/android/support/v4/app/Fragment#requireHost())`() ` Return the host object of this fragment. | | ` void` | ` `[setAllowEnterTransitionOverlap](https://developer.android.com/reference/android/support/v4/app/Fragment#setAllowEnterTransitionOverlap(boolean))`(boolean allow) ` Sets whether the the exit transition and enter transition overlap or not. | | ` void` | ` `[setAllowReturnTransitionOverlap](https://developer.android.com/reference/android/support/v4/app/Fragment#setAllowReturnTransitionOverlap(boolean))`(boolean allow) ` Sets whether the the return transition and reenter transition overlap or not. | | ` void` | ` `[setArguments](https://developer.android.com/reference/android/support/v4/app/Fragment#setArguments(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` args) ` Supply the construction arguments for this fragment. | | ` void` | ` `[setEnterSharedElementCallback](https://developer.android.com/reference/android/support/v4/app/Fragment#setEnterSharedElementCallback(android.support.v4.app.SharedElementCallback))`(`[SharedElementCallback](https://developer.android.com/reference/android/support/v4/app/SharedElementCallback)` callback) ` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack. | | ` void` | ` `[setEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setEnterTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used to move Views into the initial scene. | | ` void` | ` `[setExitSharedElementCallback](https://developer.android.com/reference/android/support/v4/app/Fragment#setExitSharedElementCallback(android.support.v4.app.SharedElementCallback))`(`[SharedElementCallback](https://developer.android.com/reference/android/support/v4/app/SharedElementCallback)` callback) ` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack. | | ` void` | ` `[setExitTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setExitTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. | | ` void` | ` `[setHasOptionsMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#setHasOptionsMenu(boolean))`(boolean hasMenu) ` Report that this fragment would like to participate in populating the options menu by receiving a call to[onCreateOptionsMenu(Menu, MenuInflater)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateOptionsMenu(android.view.Menu, android.view.MenuInflater))and related methods. | | ` void` | ` `[setInitialSavedState](https://developer.android.com/reference/android/support/v4/app/Fragment#setInitialSavedState(android.support.v4.app.Fragment.SavedState))`(`[Fragment.SavedState](https://developer.android.com/reference/android/support/v4/app/Fragment.SavedState)` state) ` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by[FragmentManager.saveFragmentInstanceState](https://developer.android.com/reference/android/support/v4/app/FragmentManager#saveFragmentInstanceState(android.support.v4.app.Fragment)). | | ` void` | ` `[setMenuVisibility](https://developer.android.com/reference/android/support/v4/app/Fragment#setMenuVisibility(boolean))`(boolean menuVisible) ` Set a hint for whether this fragment's menu should be visible. | | ` void` | ` `[setReenterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setReenterTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack. | | ` void` | ` `[setRetainInstance](https://developer.android.com/reference/android/support/v4/app/Fragment#setRetainInstance(boolean))`(boolean retain) ` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change). | | ` void` | ` `[setReturnTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setReturnTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. | | ` void` | ` `[setSharedElementEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setSharedElementEnterTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used for shared elements transferred into the content Scene. | | ` void` | ` `[setSharedElementReturnTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#setSharedElementReturnTransition(java.lang.Object))`(Object transition) ` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack. | | ` void` | ` `[setTargetFragment](https://developer.android.com/reference/android/support/v4/app/Fragment#setTargetFragment(android.support.v4.app.Fragment, int))`(`[Fragment](https://developer.android.com/reference/android/support/v4/app/Fragment)` fragment, int requestCode) ` Optional target for this fragment. | | ` void` | ` `[setUserVisibleHint](https://developer.android.com/reference/android/support/v4/app/Fragment#setUserVisibleHint(boolean))`(boolean isVisibleToUser) ` Set a hint to the system about whether this fragment's UI is currently visible to the user. | | ` boolean` | ` `[shouldShowRequestPermissionRationale](https://developer.android.com/reference/android/support/v4/app/Fragment#shouldShowRequestPermissionRationale(java.lang.String))`(String permission) ` Gets whether you should show UI with rationale for requesting a permission. | | ` void` | ` `[startActivity](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivity(android.content.Intent))`(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` intent) ` Call[startActivity(Intent)](https://developer.android.com/reference/android/app/Activity.html#startActivity(android.content.Intent))from the fragment's containing Activity. | | ` void` | ` `[startActivity](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivity(android.content.Intent, android.os.Bundle))`(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` intent, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` options) ` Call[startActivity(Intent, Bundle)](https://developer.android.com/reference/android/app/Activity.html#startActivity(android.content.Intent, android.os.Bundle))from the fragment's containing Activity. | | ` void` | ` `[startActivityForResult](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivityForResult(android.content.Intent, int))`(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` intent, int requestCode) ` Call[startActivityForResult(Intent, int)](https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int))from the fragment's containing Activity. | | ` void` | ` `[startActivityForResult](https://developer.android.com/reference/android/support/v4/app/Fragment#startActivityForResult(android.content.Intent, int, android.os.Bundle))`(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` intent, int requestCode, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` options) ` Call[startActivityForResult(Intent, int, Bundle)](https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int, android.os.Bundle))from the fragment's containing Activity. | | ` void` | ` `[startIntentSenderForResult](https://developer.android.com/reference/android/support/v4/app/Fragment#startIntentSenderForResult(android.content.IntentSender, int, android.content.Intent, int, int, int, android.os.Bundle))`(`[IntentSender](https://developer.android.com/reference/android/content/IntentSender.html)` intent, int requestCode, `[Intent](https://developer.android.com/reference/android/content/Intent.html)` fillInIntent, int flagsMask, int flagsValues, int extraFlags, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` options) ` Call[startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)](https://developer.android.com/reference/android/app/Activity.html#startIntentSenderForResult(android.content.IntentSender, int, android.content.Intent, int, int, int, android.os.Bundle))from the fragment's containing Activity. | | ` void` | ` `[startPostponedEnterTransition](https://developer.android.com/reference/android/support/v4/app/Fragment#startPostponedEnterTransition())`() ` Begin postponed transitions after[postponeEnterTransition()](https://developer.android.com/reference/android/support/v4/app/Fragment#postponeEnterTransition())was called. | | ` String` | ` `[toString](https://developer.android.com/reference/android/support/v4/app/Fragment#toString())`() ` | | ` void` | ` `[unregisterForContextMenu](https://developer.android.com/reference/android/support/v4/app/Fragment#unregisterForContextMenu(android.view.View))`(`[View](https://developer.android.com/reference/android/view/View.html)` view) ` Prevents a context menu to be shown for the given view. | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#)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/SearchSupportFragment#)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() ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#)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/SearchSupportFragment#)From interface` android.arch.lifecycle.LifecycleOwner ` |-----------------------|--------------------| | ` abstract Lifecycle` | ` getLifecycle() ` | ||
| [](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment#)From interface` android.arch.lifecycle.ViewModelStoreOwner ` |----------------------------|-------------------------| | ` abstract ViewModelStore` | ` getViewModelStore() ` | ||
## Public constructors
### SearchSupportFragment
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
SearchSupportFragment ()
```
## 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/SearchSupportFragment#setSearchQuery(android.content.Intent, boolean)).
| Returns ||
|-------------------------------------------------------------------------------|--------|
| [Intent](https://developer.android.com/reference/android/content/Intent.html) |
|
### getRowsSupportFragment
added in[version 25.4.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
RowsSupportFragment getRowsSupportFragment ()
```
Returns RowsSupportFragment that shows result rows. RowsSupportFragment is initialized after SearchSupportFragment.onCreateView().
| Returns ||
|---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|
| [RowsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment) | RowsSupportFragment 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)
```
SearchSupportFragment 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 ||
|-------------------------------------------------------------------------------------------------------------------------|-------------------------------------|
| [SearchSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment) | A new SearchSupportFragment.
|
### onCreate
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onCreate (Bundle savedInstanceState)
```
Called to do initial creation of a fragment. This is called after[onAttach(Activity)](https://developer.android.com/reference/android/support/v4/app/Fragment#onAttach(android.app.Activity))and before[onCreateView(LayoutInflater, ViewGroup, Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)).
Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, see[onActivityCreated(Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onActivityCreated(android.os.Bundle)).
Any restored child fragments will be created before the base`Fragment.onCreate`method returns.
| Parameters ||
|----------------------|------------------------------------------------------------------------------------------------------|
| `savedInstanceState` | `Bundle`: If the fragment is being re-created from a previous saved state, this is the state.
|
### onCreateView
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
View onCreateView (LayoutInflater inflater,
ViewGroup container,
Bundle savedInstanceState)
```
Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null (which is the default implementation). This will be called between[onCreate(Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onCreate(android.os.Bundle))and[onActivityCreated(Bundle)](https://developer.android.com/reference/android/support/v4/app/Fragment#onActivityCreated(android.os.Bundle)).
If you return a View from here, you will later be called in[onDestroyView()](https://developer.android.com/reference/android/support/v4/app/Fragment#onDestroyView())when the view is being released.
| Parameters ||
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `inflater` | `LayoutInflater`: The LayoutInflater object that can be used to inflate any views in the fragment,
|
| `container` | `ViewGroup`: If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
|
| `savedInstanceState` | `Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.
|
| Returns ||
|------------------------------------------------------------------------|--------------------------------------------------------|
| [View](https://developer.android.com/reference/android/view/View.html) | Return the View for the fragment's UI, or null.
|
### onDestroy
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onDestroy ()
```
Called when the fragment is no longer in use. This is called after[onStop()](https://developer.android.com/reference/android/support/v4/app/Fragment#onStop())and before[onDetach()](https://developer.android.com/reference/android/support/v4/app/Fragment#onDetach()).
### onPause
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onPause ()
```
Called when the Fragment is no longer resumed. This is generally tied to[Activity.onPause](https://developer.android.com/reference/android/app/Activity.html#onPause())of the containing Activity's lifecycle.
### onRequestPermissionsResult
added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onRequestPermissionsResult (int requestCode,
String[] permissions,
int[] grantResults)
```
Callback for the result from requesting permissions. This method is invoked for every call on[requestPermissions(String[], int)](https://developer.android.com/reference/android/support/v4/app/Fragment#requestPermissions(java.lang.String[], int)).
**Note:**It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation.
| Parameters ||
|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `requestCode` | `int`: The request code passed in[requestPermissions(String[], int)](https://developer.android.com/reference/android/support/v4/app/Fragment#requestPermissions(java.lang.String[], int)).
|
| `permissions` | `String`: The requested permissions. Never null.
|
| `grantResults` | `int`: The grant results for the corresponding permissions which is either[PERMISSION_GRANTED](https://developer.android.com/reference/android/content/pm/PackageManager.html#PERMISSION_GRANTED)or[PERMISSION_DENIED](https://developer.android.com/reference/android/content/pm/PackageManager.html#PERMISSION_DENIED). Never null.
|
### onResume
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onResume ()
```
Called when the fragment is visible to the user and actively running. This is generally tied to[Activity.onResume](https://developer.android.com/reference/android/app/Activity.html#onResume())of the containing Activity's lifecycle.
### onStart
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void onStart ()
```
Called when the Fragment is visible to the user. This is generally tied to[Activity.onStart](https://developer.android.com/reference/android/app/Activity.html#onStart())of the containing Activity's lifecycle.
### 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/SearchSupportFragment.SearchResultProvider#onQueryTextChange(java.lang.String))or[onQueryTextSubmit](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment.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 (SearchSupportFragment.SearchResultProvider searchResultProvider)
```
Sets the search provider that is responsible for returning results for the search query.
| Parameters ||
|------------------------|-----------------------------------------------------|
| `searchResultProvider` | `SearchSupportFragment.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 SearchSupportFragment 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)