# SearchSupportFragment Artifact: [androidx.leanback:leanback](https://developer.android.com/jetpack/androidx/releases/leanback) [View Source](https://cs.android.com/search?q=file:androidx/leanback/app/SearchSupportFragment.java+class:androidx.leanback.app.SearchSupportFragment) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) *** ** * ** *** ``` public class SearchSupportFragment extends Fragment ```
|---|---|---| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) ||| | ↳ | [androidx.fragment.app.Fragment](https://developer.android.com/reference/androidx/fragment/app/Fragment) || | | ↳ | [androidx.leanback.app.SearchSupportFragment](https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment) | *** ** * ** *** A fragment to handle searches. An application will supply an implementation of the `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment.SearchResultProvider` interface to handle the search and return an `https://developer.android.com/reference/androidx/leanback/widget/ObjectAdapter` containing the results. The results are rendered into a `https://developer.android.com/reference/androidx/leanback/app/RowsSupportFragment`, in the same way that they are in a `https://developer.android.com/reference/androidx/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. `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setSpeechRecognitionCallback(androidx.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 `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#startRecognition()`, typically in onNewIntent(). ## Summary | ### Nested types | |---| | `public interface https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment.SearchResultProvider` Search API to be provided by the application. | | ### Public constructors | |---| | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#SearchSupportFragment()()` | | ### Public methods | |---|---| | `static https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#createArgs(android.os.Bundle,java.lang.String)(https://developer.android.com/reference/android/os/Bundle.html args, https://developer.android.com/reference/java/lang/String.html query)` | | `static https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#createArgs(android.os.Bundle,java.lang.String,java.lang.String)(https://developer.android.com/reference/android/os/Bundle.html args, https://developer.android.com/reference/java/lang/String.html query, https://developer.android.com/reference/java/lang/String.html title)` | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#displayCompletions(android.view.inputmethod.CompletionInfo[])(CompletionInfo[] completions)` Displays the completions shown by the IME. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#displayCompletions(java.util.List)(https://developer.android.com/reference/java/util/List.html completions)` Displays the completions shown by the IME. | | `https://developer.android.com/reference/android/graphics/drawable/Drawable.html` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#getBadgeDrawable()()` Returns the badge drawable in the search bar. | | `https://developer.android.com/reference/android/content/Intent.html` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#getRecognizerIntent()()` Returns an intent that can be used to request speech recognition. | | `https://developer.android.com/reference/androidx/leanback/app/RowsSupportFragment` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#getRowsSupportFragment()()` Returns RowsSupportFragment that shows result rows. | | `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#getTitle()()` Returns the title set in the search bar. | | `static https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#newInstance(java.lang.String)(https://developer.android.com/reference/java/lang/String.html query)` Creates a search fragment with a given search query. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#onCreate(android.os.Bundle)(https://developer.android.com/reference/android/os/Bundle.html savedInstanceState)` Called to do initial creation of a fragment. | | `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/View.html` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/LayoutInflater.html inflater, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/ViewGroup.html container, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html savedInstanceState )` Called to have the fragment instantiate its user interface view. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#onDestroy()()` Called when the fragment is no longer in use. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#onDestroyView()()` Called when the view previously created by `https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)` has been detached from the fragment. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#onPause()()` Called when the Fragment is no longer resumed. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#onRequestPermissionsResult(int,java.lang.String[],int[])( int requestCode, String[] permissions, int[] grantResults )` **This method is deprecated.** This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
| | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#onResume()()` Called when the fragment is visible to the user and actively running. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#onStart()()` Called when the Fragment is visible to the user. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setBadgeDrawable(android.graphics.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` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setOnItemViewClickedListener(androidx.leanback.widget.OnItemViewClickedListener)(https://developer.android.com/reference/androidx/leanback/widget/OnItemViewClickedListener listener)` Sets an item clicked listener for the results. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setOnItemViewSelectedListener(androidx.leanback.widget.OnItemViewSelectedListener)(https://developer.android.com/reference/androidx/leanback/widget/OnItemViewSelectedListener listener)` Sets an item selection listener for the results. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setSearchAffordanceColors(androidx.leanback.widget.SearchOrbView.Colors)(https://developer.android.com/reference/androidx/leanback/widget/SearchOrbView.Colors colors)` Sets background color of not-listening state search orb. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setSearchAffordanceColorsInListening(androidx.leanback.widget.SearchOrbView.Colors)(https://developer.android.com/reference/androidx/leanback/widget/SearchOrbView.Colors colors)` Sets background color of listening state search orb. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setSearchQuery(android.content.Intent,boolean)(https://developer.android.com/reference/android/content/Intent.html intent, boolean submit)` Sets the text of the search query based on the `https://developer.android.com/reference/android/speech/RecognizerIntent.html#EXTRA_RESULTS` in the given intent, and optionally submit the query. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setSearchQuery(java.lang.String,boolean)(https://developer.android.com/reference/java/lang/String.html query, boolean submit)` Sets the text of the search query and optionally submits the query. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setSearchResultProvider(androidx.leanback.app.SearchSupportFragment.SearchResultProvider)( https://developer.android.com/reference/androidx/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/androidx/leanback/app/SearchSupportFragment#setSpeechRecognitionCallback(androidx.leanback.widget.SpeechRecognitionCallback))(https://developer.android.com/reference/androidx/leanback/widget/SpeechRecognitionCallback callback)` **This method is deprecated.** Launching voice recognition activity is no longer supported.
| | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setTitle(java.lang.String)(https://developer.android.com/reference/java/lang/String.html title)` Sets the title string to be be shown in an empty search bar. | | `void` | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#startRecognition()()` Starts speech recognition. | ### Inherited methods From [androidx.activity.result.ActivityResultCaller](https://developer.android.com/reference/androidx/activity/result/ActivityResultCaller) `abstract https://developer.android.com/reference/androidx/activity/result/ActivityResultLauncher` ` https://developer.android.com/reference/androidx/activity/result/ActivityResultCaller#registerForActivityResult(androidx.activity.result.contract.ActivityResultContract,androidx.activity.result.ActivityResultCallback)( https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract contract, https://developer.android.com/reference/androidx/activity/result/ActivityResultCallback callback )` Register a request to `https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int)`, designated by the given `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract`. From [android.content.ComponentCallbacks](https://developer.android.com/reference/android/content/ComponentCallbacks.html) `abstract void` `https://developer.android.com/reference/android/content/ComponentCallbacks.html#onConfigurationChanged(android.content.res.Configuration)(https://developer.android.com/reference/android/content/res/Configuration.html p)` `abstract void` `https://developer.android.com/reference/android/content/ComponentCallbacks.html#onLowMemory()()` **This method is deprecated.** From [androidx.activity.contextaware.ContextAware](https://developer.android.com/reference/androidx/activity/contextaware/ContextAware) `abstract void` `https://developer.android.com/reference/androidx/activity/contextaware/ContextAware#addOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)(https://developer.android.com/reference/androidx/activity/contextaware/OnContextAvailableListener listener)` Add a new `https://developer.android.com/reference/androidx/activity/contextaware/OnContextAvailableListener` for receiving a callback for when this class is associated with a `https://developer.android.com/reference/android/content/Context.html`. `abstract https://developer.android.com/reference/android/content/Context.html` `https://developer.android.com/reference/androidx/activity/contextaware/ContextAware#peekAvailableContext()()` Get the `https://developer.android.com/reference/android/content/Context.html` if it is currently available. `abstract void` `https://developer.android.com/reference/androidx/activity/contextaware/ContextAware#removeOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)(https://developer.android.com/reference/androidx/activity/contextaware/OnContextAvailableListener listener)` Remove a `https://developer.android.com/reference/androidx/activity/contextaware/OnContextAvailableListener` previously added via `https://developer.android.com/reference/androidx/activity/contextaware/ContextAware#addOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)`. From [androidx.fragment.app.Fragment](https://developer.android.com/reference/androidx/fragment/app/Fragment) `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#addOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/activity/contextaware/OnContextAvailableListener listener )` Add a new `https://developer.android.com/reference/androidx/activity/contextaware/OnContextAvailableListener` for receiving a callback for when this class is associated with a `https://developer.android.com/reference/android/content/Context.html`. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#dump(java.lang.String,java.io.FileDescriptor,java.io.PrintWriter,java.lang.String[])( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html prefix, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/io/FileDescriptor.html fd, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/io/PrintWriter.html writer, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html String[] args )` Print the Fragments's state into the given stream. `final boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#equals(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html o)` Subclasses can not override equals(). `final @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/fragment/app/FragmentActivity` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getActivity()()` Return the `https://developer.android.com/reference/androidx/fragment/app/FragmentActivity` this fragment is currently associated with. `boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getAllowEnterTransitionOverlap()()` Returns whether the the exit transition and enter transition overlap or not. `boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getAllowReturnTransitionOverlap()()` Returns whether the the return transition and reenter transition overlap or not. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getArguments()()` Return the arguments supplied when the fragment was instantiated, if any. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/fragment/app/FragmentManager` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getChildFragmentManager()()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment. `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/content/Context.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getContext()()` Return the `https://developer.android.com/reference/android/content/Context.html` this fragment is currently associated with. `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/lifecycle/viewmodel/CreationExtras` `@https://developer.android.com/reference/androidx/annotation/CallSuper https://developer.android.com/reference/androidx/fragment/app/Fragment#getDefaultViewModelCreationExtras()()` The default `https://developer.android.com/reference/androidx/lifecycle/viewmodel/CreationExtras` to pass into `https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider.Factory#create(kotlin.reflect.KClass,androidx.lifecycle.viewmodel.CreationExtras)` when no overriding `https://developer.android.com/reference/androidx/lifecycle/viewmodel/CreationExtras` are provided. `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider.Factory` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getDefaultViewModelProviderFactory()()` The default `https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider.Factory` to use when no custom `https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider.Factory` is provided to the `https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider`. `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getEnterTransition()()` Returns the Transition that will be used to move Views into the initial scene. `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html` `https://developer.android.com/reference/androidx/fragment/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 @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/fragment/app/FragmentManager` `[getFragmentManager](https://developer.android.com/reference/androidx/fragment/app/Fragment#getFragmentManager())()` **This method is deprecated.** This has been removed in favor of `getParentFragmentManager()` which throws an `https://developer.android.com/reference/java/lang/IllegalStateException.html` if the FragmentManager is null.
`final @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getHost()()` Return the host object of this fragment. `final int` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getId()()` Return the identifier this fragment is known by. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/LayoutInflater.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getLayoutInflater()()` Returns the cached LayoutInflater used to inflate Views of this Fragment. `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/lifecycle/Lifecycle` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getLifecycle()()` The `https://developer.android.com/reference/androidx/lifecycle/Lifecycle` of this owner. `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/loader/app/LoaderManager` `[getLoaderManager](https://developer.android.com/reference/androidx/fragment/app/Fragment#getLoaderManager())()` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/loader/app/LoaderManager#getInstance(T)`.
`final @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/fragment/app/Fragment` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getParentFragment()()` Returns the parent Fragment containing this Fragment. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/fragment/app/FragmentManager` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getParentFragmentManager()()` Return the FragmentManager for interacting with fragments associated with this fragment's activity. `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html` `https://developer.android.com/reference/androidx/fragment/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 @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/res/Resources.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getResources()()` Return `requireActivity().getResources()`. `final boolean` `[getRetainInstance](https://developer.android.com/reference/androidx/fragment/app/Fragment#getRetainInstance())()` **This method is deprecated.** Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html` `https://developer.android.com/reference/androidx/fragment/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. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/savedstate/SavedStateRegistry` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getSavedStateRegistry()()` The `https://developer.android.com/reference/androidx/savedstate/SavedStateRegistry` owned by this `https://developer.android.com/reference/androidx/savedstate/SavedStateRegistryOwner`. `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getSharedElementEnterTransition()()` Returns the Transition that will be used for shared elements transferred into the content Scene. `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getSharedElementReturnTransition()()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getString(int)(@https://developer.android.com/reference/androidx/annotation/StringRes int resId)` Return a localized string from the application's package's default string table. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getString(int,java.lang.Object...)(@https://developer.android.com/reference/androidx/annotation/StringRes int resId, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html Object[] formatArgs)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `https://developer.android.com/reference/java/util/Formatter.html` and `https://developer.android.com/reference/java/lang/String.html#format(java.lang.String, java.lang.Object...)`. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getTag()()` Get the tag name of the fragment, if specified. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/fragment/app/Fragment` `[getTargetFragment](https://developer.android.com/reference/androidx/fragment/app/Fragment#getTargetFragment())()` **This method is deprecated.** Instead of using a target fragment to pass results, use `https://developer.android.com/reference/androidx/fragment/app/FragmentManager#setFragmentResult(java.lang.String,android.os.Bundle)` to deliver results to `https://developer.android.com/reference/androidx/fragment/app/FragmentResultListener` instances registered by other fragments via `https://developer.android.com/reference/androidx/fragment/app/FragmentManager#setFragmentResultListener(java.lang.String,androidx.lifecycle.LifecycleOwner,androidx.fragment.app.FragmentResultListener)`.
`final int` `[getTargetRequestCode](https://developer.android.com/reference/androidx/fragment/app/Fragment#getTargetRequestCode())()` **This method is deprecated.** When using the target fragment replacement of `https://developer.android.com/reference/androidx/fragment/app/FragmentManager#setFragmentResultListener(java.lang.String,androidx.lifecycle.LifecycleOwner,androidx.fragment.app.FragmentResultListener)` and `https://developer.android.com/reference/androidx/fragment/app/FragmentManager#setFragmentResult(java.lang.String,android.os.Bundle)`, consider using `https://developer.android.com/reference/androidx/fragment/app/Fragment#setArguments(android.os.Bundle)` to pass a `requestKey` if you need to support dynamic request keys.
`final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/CharSequence.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getText(int)(@https://developer.android.com/reference/androidx/annotation/StringRes int resId)` Return a localized, styled CharSequence from the application's package's default string table. `boolean` `[getUserVisibleHint](https://developer.android.com/reference/androidx/fragment/app/Fragment#getUserVisibleHint())()` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/fragment/app/FragmentTransaction#setMaxLifecycle(androidx.fragment.app.Fragment,androidx.lifecycle.Lifecycle.State)` instead.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/View.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getView()()` Get the root view for the fragment's layout (the one returned by `https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)`), if provided. `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/lifecycle/LifecycleOwner` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#getViewLifecycleOwner()()` Get a `https://developer.android.com/reference/androidx/lifecycle/LifecycleOwner` that represents the `https://developer.android.com/reference/androidx/fragment/app/Fragment#getView()` lifecycle. `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/lifecycle/LiveData` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getViewLifecycleOwnerLiveData()()` Retrieve a `https://developer.android.com/reference/androidx/lifecycle/LiveData` which allows you to observe the `https://developer.android.com/reference/androidx/fragment/app/Fragment#getViewLifecycleOwner()`. `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/lifecycle/ViewModelStore` `https://developer.android.com/reference/androidx/fragment/app/Fragment#getViewModelStore()()` Returns the `https://developer.android.com/reference/androidx/lifecycle/ViewModelStore` associated with this Fragment `final int` `https://developer.android.com/reference/androidx/fragment/app/Fragment#hashCode()()` Subclasses can not override hashCode(). `static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/fragment/app/Fragment` `[instantiate](https://developer.android.com/reference/androidx/fragment/app/Fragment#instantiate(android.content.Context,java.lang.String))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html fname)` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/fragment/app/FragmentManager#getFragmentFactory()` and `https://developer.android.com/reference/androidx/fragment/app/FragmentFactory#instantiate(java.lang.ClassLoader,java.lang.String)`
`static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/fragment/app/Fragment` `[instantiate](https://developer.android.com/reference/androidx/fragment/app/Fragment#instantiate(android.content.Context,java.lang.String,android.os.Bundle))( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html fname, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html args )` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/fragment/app/FragmentManager#getFragmentFactory()` and `https://developer.android.com/reference/androidx/fragment/app/FragmentFactory#instantiate(java.lang.ClassLoader,java.lang.String)`, manually calling `https://developer.android.com/reference/androidx/fragment/app/Fragment#setArguments(android.os.Bundle)` on the returned Fragment.
`final boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#isAdded()()` Return true if the fragment is currently added to its activity. `final boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#isDetached()()` Return true if the fragment has been explicitly detached from the UI. `final boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#isHidden()()` Return true if the fragment has been hidden. `final boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#isInLayout()()` Return true if the layout is included as part of an activity view hierarchy via the tag. `final boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#isRemoving()()` Return true if this fragment is currently being removed from its activity. `final boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#isResumed()()` Return true if the fragment is in the resumed state. `final boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#isStateSaved()()` Returns true if this fragment is added and its state has already been saved by its host. `final boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#isVisible()()` Return true if the fragment is currently visible to the user. `void` `@https://developer.android.com/reference/androidx/annotation/MainThread @https://developer.android.com/reference/androidx/annotation/CallSuper [onActivityCreated](https://developer.android.com/reference/androidx/fragment/app/Fragment#onActivityCreated(android.os.Bundle))(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html savedInstanceState)` **This method is deprecated.** use `https://developer.android.com/reference/androidx/fragment/app/Fragment#onViewCreated(android.view.View,android.os.Bundle)` for code touching the view created by `https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)` and `https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreate(android.os.Bundle)` for other initialization.
`void` `[onActivityResult](https://developer.android.com/reference/androidx/fragment/app/Fragment#onActivityResult(int,int,android.content.Intent))(int requestCode, int resultCode, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/content/Intent.html data)` **This method is deprecated.** This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void` `@https://developer.android.com/reference/androidx/annotation/MainThread @https://developer.android.com/reference/androidx/annotation/CallSuper [onAttach](https://developer.android.com/reference/androidx/fragment/app/Fragment#onAttach(android.app.Activity))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/app/Activity.html activity)` **This method is deprecated.** See `https://developer.android.com/reference/androidx/fragment/app/Fragment#onAttach(android.content.Context)`.
`void` `@https://developer.android.com/reference/androidx/annotation/MainThread @https://developer.android.com/reference/androidx/annotation/CallSuper https://developer.android.com/reference/androidx/fragment/app/Fragment#onAttach(android.content.Context)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context)` Called when a fragment is first attached to its context. `void` `@https://developer.android.com/reference/androidx/annotation/MainThread [onAttachFragment](https://developer.android.com/reference/androidx/fragment/app/Fragment#onAttachFragment(androidx.fragment.app.Fragment))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/fragment/app/Fragment childFragment)` **This method is deprecated.** The responsibility for listening for fragments being attached has been moved to FragmentManager.
`void` `@https://developer.android.com/reference/androidx/annotation/CallSuper https://developer.android.com/reference/androidx/fragment/app/Fragment#onConfigurationChanged(android.content.res.Configuration)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/res/Configuration.html newConfig)` `boolean` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#onContextItemSelected(android.view.MenuItem)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/MenuItem.html item)` This hook is called whenever an item in a context menu is selected. `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/animation/Animation.html` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateAnimation(int,boolean,int)(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation. `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/animation/Animator.html` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateAnimator(int,boolean,int)(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animator. `void` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateContextMenu(android.view.ContextMenu,android.view.View,android.view.ContextMenu.ContextMenuInfo)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/ContextMenu.html menu, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html v, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html 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` `@https://developer.android.com/reference/androidx/annotation/MainThread [onCreateOptionsMenu](https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateOptionsMenu(android.view.Menu,android.view.MenuInflater))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/Menu.html menu, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/MenuInflater.html inflater)` **This method is deprecated.** `https://developer.android.com/reference/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/androidx/activity/ComponentActivity#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.
`void` `@https://developer.android.com/reference/androidx/annotation/MainThread [onDestroyOptionsMenu](https://developer.android.com/reference/androidx/fragment/app/Fragment#onDestroyOptionsMenu())()` **This method is deprecated.** `https://developer.android.com/reference/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/androidx/core/view/MenuHost#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.
`void` `@https://developer.android.com/reference/androidx/annotation/MainThread @https://developer.android.com/reference/androidx/annotation/CallSuper https://developer.android.com/reference/androidx/fragment/app/Fragment#onDetach()()` Called when the fragment is no longer attached to its activity. `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/LayoutInflater.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#onGetLayoutInflater(android.os.Bundle)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment. `void` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#onHiddenChanged(boolean)(boolean hidden)` Called when the hidden state (as returned by `https://developer.android.com/reference/androidx/fragment/app/Fragment#isHidden()` of the fragment or another fragment in its hierarchy has changed. `void` `@https://developer.android.com/reference/androidx/annotation/UiThread @https://developer.android.com/reference/androidx/annotation/CallSuper [onInflate](https://developer.android.com/reference/androidx/fragment/app/Fragment#onInflate(android.app.Activity,android.util.AttributeSet,android.os.Bundle))( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/app/Activity.html activity, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/util/AttributeSet.html attrs, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html savedInstanceState )` **This method is deprecated.** See `https://developer.android.com/reference/androidx/fragment/app/Fragment#onInflate(android.content.Context,android.util.AttributeSet,android.os.Bundle)`.
`void` `@https://developer.android.com/reference/androidx/annotation/UiThread @https://developer.android.com/reference/androidx/annotation/CallSuper https://developer.android.com/reference/androidx/fragment/app/Fragment#onInflate(android.content.Context,android.util.AttributeSet,android.os.Bundle)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/util/AttributeSet.html attrs, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html 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` `@https://developer.android.com/reference/androidx/annotation/MainThread @https://developer.android.com/reference/androidx/annotation/CallSuper https://developer.android.com/reference/androidx/fragment/app/Fragment#onLowMemory()()` **This method is deprecated.** `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#onMultiWindowModeChanged(boolean)(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. `boolean` `@https://developer.android.com/reference/androidx/annotation/MainThread [onOptionsItemSelected](https://developer.android.com/reference/androidx/fragment/app/Fragment#onOptionsItemSelected(android.view.MenuItem))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/MenuItem.html item)` **This method is deprecated.** `https://developer.android.com/reference/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/androidx/core/view/MenuHost#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.
`void` `@https://developer.android.com/reference/androidx/annotation/MainThread [onOptionsMenuClosed](https://developer.android.com/reference/androidx/fragment/app/Fragment#onOptionsMenuClosed(android.view.Menu))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/Menu.html menu)` **This method is deprecated.** `https://developer.android.com/reference/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/androidx/core/view/MenuHost#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.
`void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#onPictureInPictureModeChanged(boolean)(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode. `void` `@https://developer.android.com/reference/androidx/annotation/MainThread [onPrepareOptionsMenu](https://developer.android.com/reference/androidx/fragment/app/Fragment#onPrepareOptionsMenu(android.view.Menu))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/Menu.html menu)` **This method is deprecated.** `https://developer.android.com/reference/androidx/activity/ComponentActivity` now implements `https://developer.android.com/reference/androidx/core/view/MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `https://developer.android.com/reference/androidx/core/view/MenuHost#addMenuProvider(androidx.core.view.MenuProvider)` without forcing all components through this single method override.
`void` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#onPrimaryNavigationFragmentChanged(boolean)( boolean isPrimaryNavigationFragment )` Callback for when the primary navigation state of this Fragment has changed. `void` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#onSaveInstanceState(android.os.Bundle)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html 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 if its process is restarted. `void` `@https://developer.android.com/reference/androidx/annotation/MainThread @https://developer.android.com/reference/androidx/annotation/CallSuper https://developer.android.com/reference/androidx/fragment/app/Fragment#onStop()()` Called when the Fragment is no longer started. `void` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#onViewCreated(android.view.View,android.os.Bundle)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html view, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html savedInstanceState)` Called immediately after `https://developer.android.com/reference/androidx/fragment/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` `@https://developer.android.com/reference/androidx/annotation/MainThread @https://developer.android.com/reference/androidx/annotation/CallSuper https://developer.android.com/reference/androidx/fragment/app/Fragment#onViewStateRestored(android.os.Bundle)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html 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. `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/content/Context.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#peekAvailableContext()()` Get the `https://developer.android.com/reference/android/content/Context.html` if it is currently available. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#postponeEnterTransition()()` Postpone the entering Fragment transition until `https://developer.android.com/reference/androidx/fragment/app/Fragment#startPostponedEnterTransition()` or `https://developer.android.com/reference/androidx/fragment/app/FragmentManager#executePendingTransactions()` has been called. `final void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#postponeEnterTransition(long,java.util.concurrent.TimeUnit)(long duration, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/concurrent/TimeUnit.html timeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `https://developer.android.com/reference/androidx/fragment/app/Fragment#startPostponedEnterTransition()`. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/activity/result/ActivityResultLauncher` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#registerForActivityResult(androidx.activity.result.contract.ActivityResultContract,androidx.activity.result.ActivityResultCallback)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract contract, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/activity/result/ActivityResultCallback callback )` Register a request to `https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int)`, designated by the given `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract`.
`final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/activity/result/ActivityResultLauncher` `@https://developer.android.com/reference/androidx/annotation/MainThread https://developer.android.com/reference/androidx/fragment/app/Fragment#registerForActivityResult(androidx.activity.result.contract.ActivityResultContract,androidx.activity.result.ActivityResultRegistry,androidx.activity.result.ActivityResultCallback)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract contract, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/activity/result/ActivityResultRegistry registry, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/activity/result/ActivityResultCallback callback )` Register a request to `https://developer.android.com/reference/android/app/Activity.html#startActivityForResult(android.content.Intent, int)`, designated by the given `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract`. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#registerForContextMenu(android.view.View)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html 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). `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#removeOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/activity/contextaware/OnContextAvailableListener listener )` Remove a `https://developer.android.com/reference/androidx/activity/contextaware/OnContextAvailableListener` previously added via `https://developer.android.com/reference/androidx/activity/contextaware/ContextAware#addOnContextAvailableListener(androidx.activity.contextaware.OnContextAvailableListener)`. `final void` `[requestPermissions](https://developer.android.com/reference/androidx/fragment/app/Fragment#requestPermissions(java.lang.String[],int))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html String[] permissions, int requestCode)` **This method is deprecated.** This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/fragment/app/FragmentActivity` `https://developer.android.com/reference/androidx/fragment/app/Fragment#requireActivity()()` Return the `https://developer.android.com/reference/androidx/fragment/app/FragmentActivity` this fragment is currently associated with. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/os/Bundle.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#requireArguments()()` Return the arguments supplied when the fragment was instantiated. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#requireContext()()` Return the `https://developer.android.com/reference/android/content/Context.html` this fragment is currently associated with. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/fragment/app/FragmentManager` `[requireFragmentManager](https://developer.android.com/reference/androidx/fragment/app/Fragment#requireFragmentManager())()` **This method is deprecated.** This has been renamed to `getParentFragmentManager()` to make it clear that you are accessing the FragmentManager that contains this Fragment and not the FragmentManager associated with child Fragments.
`final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/Object.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#requireHost()()` Return the host object of this fragment. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/fragment/app/Fragment` `https://developer.android.com/reference/androidx/fragment/app/Fragment#requireParentFragment()()` Returns the parent Fragment containing this Fragment. `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#requireView()()` Get the root view for the fragment's layout (the one returned by `https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)`). `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setAllowEnterTransitionOverlap(boolean)(boolean allow)` Sets whether the the exit transition and enter transition overlap or not. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setAllowReturnTransitionOverlap(boolean)(boolean allow)` Sets whether the the return transition and reenter transition overlap or not. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setArguments(android.os.Bundle)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html args)` Supply the construction arguments for this fragment. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setEnterSharedElementCallback(androidx.core.app.SharedElementCallback)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/core/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` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setEnterTransition(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html transition)` Sets the Transition that will be used to move Views into the initial scene. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setExitSharedElementCallback(androidx.core.app.SharedElementCallback)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/core/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` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setExitTransition(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html 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/androidx/fragment/app/Fragment#setHasOptionsMenu(boolean))(boolean hasMenu)` **This method is deprecated.** This method is no longer needed when using a `https://developer.android.com/reference/androidx/core/view/MenuProvider` to provide a `https://developer.android.com/reference/android/view/Menu.html` to your activity, which replaces `https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateOptionsMenu(android.view.Menu,android.view.MenuInflater)` as the recommended way to provide a consistent, optionally `https://developer.android.com/reference/androidx/lifecycle/Lifecycle`-aware, and modular way to handle menu creation and item selection.
`void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setInitialSavedState(androidx.fragment.app.Fragment.SavedState)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/fragment/app/Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `https://developer.android.com/reference/androidx/fragment/app/FragmentManager#saveFragmentInstanceState(androidx.fragment.app.Fragment)`. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setMenuVisibility(boolean)(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setReenterTransition(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html 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/androidx/fragment/app/Fragment#setRetainInstance(boolean))(boolean retain)` **This method is deprecated.** Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setReturnTransition(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html 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` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setSharedElementEnterTransition(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html transition)` Sets the Transition that will be used for shared elements transferred into the content Scene. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#setSharedElementReturnTransition(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html 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/androidx/fragment/app/Fragment#setTargetFragment(androidx.fragment.app.Fragment,int))(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/fragment/app/Fragment fragment, int requestCode)` **This method is deprecated.** Instead of using a target fragment to pass results, the fragment requesting a result should use `https://developer.android.com/reference/androidx/fragment/app/FragmentManager#setFragmentResultListener(java.lang.String,androidx.lifecycle.LifecycleOwner,androidx.fragment.app.FragmentResultListener)` to register a `https://developer.android.com/reference/androidx/fragment/app/FragmentResultListener` with a ` requestKey` using its `https://developer.android.com/reference/androidx/fragment/app/Fragment#getParentFragmentManager()`.
`void` `[setUserVisibleHint](https://developer.android.com/reference/androidx/fragment/app/Fragment#setUserVisibleHint(boolean))(boolean isVisibleToUser)` **This method is deprecated.** If you are manually calling this method, use `https://developer.android.com/reference/androidx/fragment/app/FragmentTransaction#setMaxLifecycle(androidx.fragment.app.Fragment,androidx.lifecycle.Lifecycle.State)` instead.
`boolean` `https://developer.android.com/reference/androidx/fragment/app/Fragment#shouldShowRequestPermissionRationale(java.lang.String)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html permission)` Gets whether you should show UI with rationale before requesting a permission. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#startActivity(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Call `https://developer.android.com/reference/android/app/Activity.html#startActivity(android.content.Intent)` from the fragment's containing Activity. `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#startActivity(android.content.Intent,android.os.Bundle)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html options)` Call `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/androidx/fragment/app/Fragment#startActivityForResult(android.content.Intent,int))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent, int requestCode)` **This method is deprecated.** This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void` `[startActivityForResult](https://developer.android.com/reference/androidx/fragment/app/Fragment#startActivityForResult(android.content.Intent,int,android.os.Bundle))( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent, int requestCode, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html options )` **This method is deprecated.** This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void` `[startIntentSenderForResult](https://developer.android.com/reference/androidx/fragment/app/Fragment#startIntentSenderForResult(android.content.IntentSender,int,android.content.Intent,int,int,int,android.os.Bundle))( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/IntentSender.html intent, int requestCode, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/content/Intent.html fillInIntent, int flagsMask, int flagsValues, int extraFlags, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html options )` **This method is deprecated.** This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#startPostponedEnterTransition()()` Begin postponed transitions after `https://developer.android.com/reference/androidx/fragment/app/Fragment#postponeEnterTransition()` was called. `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/fragment/app/Fragment#toString()()` `void` `https://developer.android.com/reference/androidx/fragment/app/Fragment#unregisterForContextMenu(android.view.View)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html view)` Prevents a context menu to be shown for the given view. From [androidx.lifecycle.HasDefaultViewModelProviderFactory](https://developer.android.com/reference/androidx/lifecycle/HasDefaultViewModelProviderFactory) `https://developer.android.com/reference/androidx/lifecycle/viewmodel/CreationExtras` `https://developer.android.com/reference/androidx/lifecycle/HasDefaultViewModelProviderFactory#getDefaultViewModelCreationExtras()()` The default `https://developer.android.com/reference/androidx/lifecycle/viewmodel/CreationExtras` to pass into `https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider.Factory#create(kotlin.reflect.KClass,androidx.lifecycle.viewmodel.CreationExtras)` when no overriding `https://developer.android.com/reference/androidx/lifecycle/viewmodel/CreationExtras` are provided. `https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider.Factory` `https://developer.android.com/reference/androidx/lifecycle/HasDefaultViewModelProviderFactory#getDefaultViewModelProviderFactory()()` The default `https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider.Factory` to use when no custom `https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider.Factory` is provided to the `https://developer.android.com/reference/androidx/lifecycle/ViewModelProvider`. From [androidx.lifecycle.LifecycleOwner](https://developer.android.com/reference/androidx/lifecycle/LifecycleOwner) `abstract https://developer.android.com/reference/androidx/lifecycle/Lifecycle` `https://developer.android.com/reference/androidx/lifecycle/LifecycleOwner#getLifecycle()()` The `https://developer.android.com/reference/androidx/lifecycle/Lifecycle` of this owner. From [androidx.savedstate.SavedStateRegistryOwner](https://developer.android.com/reference/androidx/savedstate/SavedStateRegistryOwner) `abstract https://developer.android.com/reference/androidx/savedstate/SavedStateRegistry` `https://developer.android.com/reference/androidx/savedstate/SavedStateRegistryOwner#getSavedStateRegistry()()` The `https://developer.android.com/reference/androidx/savedstate/SavedStateRegistry` owned by this `https://developer.android.com/reference/androidx/savedstate/SavedStateRegistryOwner`. From [android.view.View.OnCreateContextMenuListener](https://developer.android.com/reference/android/view/View.OnCreateContextMenuListener.html) `abstract void` `https://developer.android.com/reference/android/view/View.OnCreateContextMenuListener.html#onCreateContextMenu(android.view.ContextMenu, android.view.View, android.view.ContextMenu.ContextMenuInfo)( https://developer.android.com/reference/android/view/ContextMenu.html p, https://developer.android.com/reference/android/view/View.html p1, https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html p2 )` From [androidx.lifecycle.ViewModelStoreOwner](https://developer.android.com/reference/androidx/lifecycle/ViewModelStoreOwner) `abstract https://developer.android.com/reference/androidx/lifecycle/ViewModelStore` `https://developer.android.com/reference/androidx/lifecycle/ViewModelStoreOwner#getViewModelStore()()` The owned `https://developer.android.com/reference/androidx/lifecycle/ViewModelStore` ## Public constructors ### SearchSupportFragment Added in 1.1.0 ``` public SearchSupportFragment() ``` ## Public methods ### createArgs Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public static Bundle createArgs(Bundle args, String query) ``` | Parameters | |---|---| | `https://developer.android.com/reference/android/os/Bundle.html args` | Bundle to use for the arguments, if null a new Bundle will be created. | | `https://developer.android.com/reference/java/lang/String.html query` | The search query, which is added to the bundle | ### createArgs Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public static Bundle createArgs(Bundle args, String query, String title) ``` ### displayCompletions Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public 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 | |---|---| | `CompletionInfo[] completions` | A list of completions to show in the IME. Setting to null or empty will clear the list. | ### displayCompletions Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public 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 | |---|---| | `https://developer.android.com/reference/java/util/List.html completions` | A list of completions to show in the IME. Setting to null or empty will clear the list. | ### getBadgeDrawable Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public Drawable getBadgeDrawable() ``` Returns the badge drawable in the search bar. ### getRecognizerIntent Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public Intent getRecognizerIntent() ``` Returns an intent that can be used to request speech recognition. Built from the base `https://developer.android.com/reference/android/speech/RecognizerIntent.html#ACTION_RECOGNIZE_SPEECH` plus extras: - `https://developer.android.com/reference/android/speech/RecognizerIntent.html#EXTRA_LANGUAGE_MODEL` set to `https://developer.android.com/reference/android/speech/RecognizerIntent.html#LANGUAGE_MODEL_FREE_FORM` - `https://developer.android.com/reference/android/speech/RecognizerIntent.html#EXTRA_PARTIAL_RESULTS` set to true - `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 `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setSearchQuery(android.content.Intent,boolean)`. ### getRowsSupportFragment Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public RowsSupportFragment getRowsSupportFragment() ``` Returns RowsSupportFragment that shows result rows. RowsSupportFragment is initialized after SearchSupportFragment.onCreateView(). | Returns | |---|---| | `https://developer.android.com/reference/androidx/leanback/app/RowsSupportFragment` | RowsSupportFragment that shows result rows. | ### getTitle Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public String getTitle() ``` Returns the title set in the search bar. ### newInstance Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public static 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 | |---|---| | `https://developer.android.com/reference/java/lang/String.html query` | The search query to begin with. | | Returns | |---|---| | `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment` | A new SearchSupportFragment. | ### onCreate ``` public void onCreate(Bundle savedInstanceState) ``` Called to do initial creation of a fragment. This is called after `https://developer.android.com/reference/androidx/fragment/app/Fragment#onAttach(android.app.Activity)` and before `https://developer.android.com/reference/androidx/fragment/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, add a `https://developer.android.com/reference/androidx/lifecycle/LifecycleObserver` on the activity's Lifecycle, removing it when it receives the `https://developer.android.com/reference/androidx/lifecycle/Lifecycle.State#CREATED` callback. Any restored child fragments will be created before the base `Fragment.onCreate` method returns. | Parameters | |---|---| | `https://developer.android.com/reference/android/os/Bundle.html savedInstanceState` | If the fragment is being re-created from a previous saved state, this is the state. | ### onCreateView ``` public @Nullable View onCreateView(     @NonNull LayoutInflater inflater,     @Nullable ViewGroup container,     @Nullable Bundle savedInstanceState ) ``` Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null. This will be called between `https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreate(android.os.Bundle)` and `https://developer.android.com/reference/androidx/fragment/app/Fragment#onViewCreated(android.view.View,android.os.Bundle)`. A default View can be returned by calling `https://developer.android.com/reference/androidx/fragment/app/Fragment#Fragment(int)` in your constructor. Otherwise, this method returns null. It is recommended to **only** inflate the layout in this method and move logic that operates on the returned View to `https://developer.android.com/reference/androidx/fragment/app/Fragment#onViewCreated(android.view.View,android.os.Bundle)`. If you return a View from here, you will later be called in `https://developer.android.com/reference/androidx/fragment/app/Fragment#onDestroyView()` when the view is being released. | Parameters | |---|---| | `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/LayoutInflater.html inflater` | The LayoutInflater object that can be used to inflate any views in the fragment, | | `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/ViewGroup.html container` | 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. | | `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html savedInstanceState` | If non-null, this fragment is being re-constructed from a previous saved state as given here. | | Returns | |---|---| | `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/view/View.html` | Return the View for the fragment's UI, or null. | ### onDestroy ``` public void onDestroy() ``` Called when the fragment is no longer in use. This is called after `https://developer.android.com/reference/androidx/fragment/app/Fragment#onStop()` and before `https://developer.android.com/reference/androidx/fragment/app/Fragment#onDetach()`. ### onDestroyView ``` public void onDestroyView() ``` Called when the view previously created by `https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)` has been detached from the fragment. The next time the fragment needs to be displayed, a new view will be created. This is called after `https://developer.android.com/reference/androidx/fragment/app/Fragment#onStop()` and before `https://developer.android.com/reference/androidx/fragment/app/Fragment#onDestroy()`. It is called *regardless* of whether `https://developer.android.com/reference/androidx/fragment/app/Fragment#onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)` returned a non-null view. Internally it is called after the view's state has been saved but before it has been removed from its parent. ### onPause ``` public void onPause() ``` Called when the Fragment is no longer resumed. This is generally tied to `https://developer.android.com/reference/android/app/Activity.html#onPause()` of the containing Activity's lifecycle. ### onRequestPermissionsResult ``` public void onRequestPermissionsResult(     int requestCode,     String[] permissions,     int[] grantResults ) ``` > [!CAUTION] > **This method is deprecated.** > > This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract` and the prebuilt contracts for common intents available in `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment. Use `https://developer.android.com/reference/androidx/fragment/app/Fragment#registerForActivityResult(androidx.activity.result.contract.ActivityResultContract,androidx.activity.result.ActivityResultCallback)` passing in a `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContracts.RequestMultiplePermissions` object for the `https://developer.android.com/reference/androidx/activity/result/contract/ActivityResultContract` and handling the result in the `https://developer.android.com/reference/androidx/activity/result/ActivityResultCallback#onActivityResult(O)`. Callback for the result from requesting permissions. This method is invoked for every call on `https://developer.android.com/reference/androidx/fragment/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 | |---|---| | `int requestCode` | The request code passed in `https://developer.android.com/reference/androidx/fragment/app/Fragment#requestPermissions(java.lang.String[],int)`. | | `String[] permissions` | The requested permissions. Never null. | | `int[] grantResults` | The grant results for the corresponding permissions which is either `https://developer.android.com/reference/android/content/pm/PackageManager.html#PERMISSION_GRANTED` or `https://developer.android.com/reference/android/content/pm/PackageManager.html#PERMISSION_DENIED`. Never null. | | See also | |---|---| | `https://developer.android.com/reference/androidx/fragment/app/Fragment#requestPermissions(java.lang.String[],int)` | | ### onResume ``` public void onResume() ``` Called when the fragment is visible to the user and actively running. This is generally tied to `https://developer.android.com/reference/android/app/Activity.html#onResume()` of the containing Activity's lifecycle. ### onStart ``` public void onStart() ``` Called when the Fragment is visible to the user. This is generally tied to `https://developer.android.com/reference/android/app/Activity.html#onStart()` of the containing Activity's lifecycle. ### setBadgeDrawable Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public void setBadgeDrawable(Drawable drawable) ``` Sets the badge drawable that will be shown inside the search bar next to the title. ### setOnItemViewClickedListener Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public void setOnItemViewClickedListener(OnItemViewClickedListener listener) ``` Sets an item clicked listener for the results. | Parameters | |---|---| | `https://developer.android.com/reference/androidx/leanback/widget/OnItemViewClickedListener listener` | The item clicked listener to be invoked when an item in the search results is clicked. | ### setOnItemViewSelectedListener Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public void setOnItemViewSelectedListener(OnItemViewSelectedListener listener) ``` Sets an item selection listener for the results. | Parameters | |---|---| | `https://developer.android.com/reference/androidx/leanback/widget/OnItemViewSelectedListener listener` | The item selection listener to be invoked when an item in the search results is selected. | ### setSearchAffordanceColors Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public void setSearchAffordanceColors(SearchOrbView.Colors colors) ``` Sets background color of not-listening state search orb. | Parameters | |---|---| | `https://developer.android.com/reference/androidx/leanback/widget/SearchOrbView.Colors colors` | SearchOrbView.Colors. | ### setSearchAffordanceColorsInListening Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public void setSearchAffordanceColorsInListening(SearchOrbView.Colors colors) ``` Sets background color of listening state search orb. | Parameters | |---|---| | `https://developer.android.com/reference/androidx/leanback/widget/SearchOrbView.Colors colors` | SearchOrbView.Colors. | ### setSearchQuery Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public void setSearchQuery(Intent intent, boolean submit) ``` Sets the text of the search query based on the `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 | |---|---| | `https://developer.android.com/reference/android/content/Intent.html intent` | Intent received from a speech recognition service. | | `boolean submit` | Whether to submit the query. | ### setSearchQuery Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public void setSearchQuery(String query, boolean submit) ``` Sets the text of the search query and optionally submits the query. Either `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment.SearchResultProvider#onQueryTextChange(java.lang.String)` or `https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment.SearchResultProvider#onQueryTextSubmit(java.lang.String)` will be called on the provider if it is set. | Parameters | |---|---| | `https://developer.android.com/reference/java/lang/String.html query` | The search query to set. | | `boolean submit` | Whether to submit the query. | ### setSearchResultProvider Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public void setSearchResultProvider(     SearchSupportFragment.SearchResultProvider searchResultProvider ) ``` Sets the search provider that is responsible for returning results for the search query. ### setSpeechRecognitionCallback Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public void [setSpeechRecognitionCallback](https://developer.android.com/reference/androidx/leanback/app/SearchSupportFragment#setSpeechRecognitionCallback(androidx.leanback.widget.SpeechRecognitionCallback))(SpeechRecognitionCallback callback) ``` > [!CAUTION] > **This method is deprecated.** > > 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. ### setTitle Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public 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*". ### startRecognition Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` public 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.