SearchSupportFragment

Added in 1.1.0

Kotlin |Java

class SearchSupportFragment : Fragment

kotlin.Any
↳	androidx.fragment.app.Fragment
	↳	androidx.leanback.app.SearchSupportFragment

A fragment to handle searches. An application will supply an implementation of the SearchResultProvider interface to handle the search and return an ObjectAdapter containing the results. The results are rendered into a RowsSupportFragment, in the same way that they are in a 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 is deprecated.

Speech recognition is automatically started when fragment is created, but not when fragment is restored from an instance state. Activity may manually call startRecognition, typically in onNewIntent().

Summary

Nested types
`interface SearchSupportFragment.SearchResultProvider` Search API to be provided by the application.

Public constructors
`SearchSupportFragment()`

Public functions
`java-static Bundle!`	`createArgs(args: Bundle!, query: String!)`
`java-static Bundle!`	`createArgs(args: Bundle!, query: String!, title: String!)`
`Unit`	`displayCompletions(completions: Array<CompletionInfo!>!)` Displays the completions shown by the IME.
`Unit`	`displayCompletions(completions: (Mutable)List<String!>!)` Displays the completions shown by the IME.
`Drawable!`	`getBadgeDrawable()` Returns the badge drawable in the search bar.
`Intent!`	`getRecognizerIntent()` Returns an intent that can be used to request speech recognition.
`RowsSupportFragment!`	`getRowsSupportFragment()` Returns RowsSupportFragment that shows result rows.
`String!`	`getTitle()` Returns the title set in the search bar.
`java-static SearchSupportFragment!`	`newInstance(query: String!)` Creates a search fragment with a given search query.
`Unit`	`onCreate(savedInstanceState: Bundle!)` Called to do initial creation of a fragment.
`View?`	`onCreateView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle? )` Called to have the fragment instantiate its user interface view.
`Unit`	`onDestroy()` Called when the fragment is no longer in use.
`Unit`	`onDestroyView()` Called when the view previously created by `onCreateView` has been detached from the fragment.
`Unit`	`onPause()` Called when the Fragment is no longer resumed.
`Unit`	`onRequestPermissionsResult( requestCode: Int, permissions: Array<String!>!, grantResults: IntArray<Int>! )` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`onResume()` Called when the fragment is visible to the user and actively running.
`Unit`	`onStart()` Called when the Fragment is visible to the user.
`Unit`	`setBadgeDrawable(drawable: Drawable!)` Sets the badge drawable that will be shown inside the search bar next to the title.
`Unit`	`setOnItemViewClickedListener(listener: OnItemViewClickedListener!)` Sets an item clicked listener for the results.
`Unit`	`setOnItemViewSelectedListener(listener: OnItemViewSelectedListener!)` Sets an item selection listener for the results.
`Unit`	`setSearchAffordanceColors(colors: SearchOrbView.Colors!)` Sets background color of not-listening state search orb.
`Unit`	`setSearchAffordanceColorsInListening(colors: SearchOrbView.Colors!)` Sets background color of listening state search orb.
`Unit`	`setSearchQuery(intent: Intent!, submit: Boolean)` Sets the text of the search query based on the `EXTRA_RESULTS` in the given intent, and optionally submit the query.
`Unit`	`setSearchQuery(query: String!, submit: Boolean)` Sets the text of the search query and optionally submits the query.
`Unit`	`setSearchResultProvider( searchResultProvider: SearchSupportFragment.SearchResultProvider! )` Sets the search provider that is responsible for returning results for the search query.
`Unit`	`setSpeechRecognitionCallback(callback: SpeechRecognitionCallback!)` This function is deprecated. Launching voice recognition activity is no longer supported.
`Unit`	`setTitle(title: String!)` Sets the title string to be be shown in an empty search bar.
`Unit`	`startRecognition()` Starts speech recognition.

Inherited functions

From androidx.activity.result.ActivityResultCaller

abstract ActivityResultLauncher<I!>!

<I, O> registerForActivityResult(
    contract: ActivityResultContract<I!, O!>!,
    callback: ActivityResultCallback<O!>!
)

From android.content.ComponentCallbacks

`abstract Unit`	`onConfigurationChanged(p: Configuration!)`
`abstract Unit`	`onLowMemory()` This function is deprecated.

From androidx.activity.contextaware.ContextAware

`abstract Unit`	`addOnContextAvailableListener(listener: OnContextAvailableListener!)` Add a new `OnContextAvailableListener` for receiving a callback for when this class is associated with a `android.content.Context`.
`abstract Context!`	`peekAvailableContext()` Get the `Context` if it is currently available.
`abstract Unit`	`removeOnContextAvailableListener(listener: OnContextAvailableListener!)` Remove a `OnContextAvailableListener` previously added via `addOnContextAvailableListener`.

From androidx.fragment.app.Fragment

`Unit`	`addOnContextAvailableListener(listener: OnContextAvailableListener)` Add a new `OnContextAvailableListener` for receiving a callback for when this class is associated with a `android.content.Context`.
`Unit`	`dump( prefix: String, fd: FileDescriptor?, writer: PrintWriter, args: Array<String!>? )` Print the Fragments's state into the given stream.
`Boolean`	`equals(o: Any?)` Subclasses can not override equals().
`FragmentActivity?`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`Boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
`Boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
`Bundle?`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context?`	`getContext()` Return the `Context` this fragment is currently associated with.
`CreationExtras`	`@CallSuper getDefaultViewModelCreationExtras()` Returns the default `CreationExtras` that should be passed into `ViewModelProvider.Factory.create` when no overriding `CreationExtras` were passed to the `ViewModelProvider` constructors.
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors.
`Any?`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`Any?`	`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.
`FragmentManager?`	`getFragmentManager()` This function is deprecated. This has been removed in favor of `getParentFragmentManager()` which throws an `IllegalStateException` if the FragmentManager is null.
`Any?`	`getHost()` Return the host object of this fragment.
`Int`	`getId()` Return the identifier this fragment is known by.
`LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`Lifecycle`	`getLifecycle()` Returns the Lifecycle of the provider.
`LoaderManager`	`getLoaderManager()` This function is deprecated. Use `LoaderManager.getInstance(this)`.
`Fragment?`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`Any?`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`Resources`	`getResources()` Return `requireActivity().getResources()`.
`Boolean`	`getRetainInstance()` This function is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`Any?`	`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.
`SavedStateRegistry`	`getSavedStateRegistry()` The `SavedStateRegistry` owned by this SavedStateRegistryOwner
`Any?`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Any?`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`String`	`getString(resId: @StringRes Int)` Return a localized string from the application's package's default string table.
`String`	`getString(resId: @StringRes Int, formatArgs: Array<Any!>?)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `java.util.Formatter` and `format`.
`String?`	`getTag()` Get the tag name of the fragment, if specified.
`Fragment?`	`getTargetFragment()` This function is deprecated. Instead of using a target fragment to pass results, use `setFragmentResult` to deliver results to `FragmentResultListener` instances registered by other fragments via `setFragmentResultListener`.
`Int`	`getTargetRequestCode()` This function is deprecated. When using the target fragment replacement of `setFragmentResultListener` and `setFragmentResult`, consider using `setArguments` to pass a `requestKey` if you need to support dynamic request keys.
`CharSequence`	`getText(resId: @StringRes Int)` Return a localized, styled CharSequence from the application's package's default string table.
`Boolean`	`getUserVisibleHint()` This function is deprecated. Use `setMaxLifecycle` instead.
`View?`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView`), if provided.
`LifecycleOwner`	`@MainThread getViewLifecycleOwner()` Get a `LifecycleOwner` that represents the `Fragment's View` lifecycle.
`LiveData<LifecycleOwner!>`	`getViewLifecycleOwnerLiveData()` Retrieve a `LiveData` which allows you to observe the `lifecycle of the Fragment's View`.
`ViewModelStore`	`getViewModelStore()` Returns the `ViewModelStore` associated with this Fragment
`Int`	`hashCode()` Subclasses can not override hashCode().
`java-static Fragment`	`instantiate(context: Context, fname: String)` This function is deprecated. Use `getFragmentFactory` and `instantiate`
`java-static Fragment`	`instantiate(context: Context, fname: String, args: Bundle?)` This function is deprecated. Use `getFragmentFactory` and `instantiate`, manually calling `setArguments` on the returned Fragment.
`Boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`Boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`Boolean`	`isHidden()` Return true if the fragment has been hidden.
`Boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the tag.
`Boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`Boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`Boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`Boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`Unit`	`@MainThread @CallSuper onActivityCreated(savedInstanceState: Bundle?)` This function is deprecated. use `onViewCreated` for code touching the view created by `onCreateView` and `onCreate` for other initialization.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, data: Intent?)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`@MainThread @CallSuper onAttach(activity: Activity)` This function is deprecated. See `onAttach`.
`Unit`	`@MainThread @CallSuper onAttach(context: Context)` Called when a fragment is first attached to its context.
`Unit`	`@MainThread onAttachFragment(childFragment: Fragment)` This function is deprecated. The responsibility for listening for fragments being attached has been moved to FragmentManager.
`Unit`	`@CallSuper onConfigurationChanged(newConfig: Configuration)`
`Boolean`	`@MainThread onContextItemSelected(item: MenuItem)` This hook is called whenever an item in a context menu is selected.
`Animation?`	`@MainThread onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animation.
`Animator?`	`@MainThread onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animator.
`Unit`	`@MainThread onCreateContextMenu( menu: ContextMenu, v: View, menuInfo: ContextMenu.ContextMenuInfo? )` Called when a context menu for the `view` is about to be shown.
`Unit`	`@MainThread onCreateOptionsMenu(menu: Menu, inflater: MenuInflater)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`@MainThread onDestroyOptionsMenu()` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`@MainThread @CallSuper onDetach()` Called when the fragment is no longer attached to its activity.
`LayoutInflater`	`onGetLayoutInflater(savedInstanceState: Bundle?)` Returns the LayoutInflater used to inflate Views of this Fragment.
`Unit`	`@MainThread onHiddenChanged(hidden: Boolean)` Called when the hidden state (as returned by `isHidden` of the fragment or another fragment in its hierarchy has changed.
`Unit`	`@UiThread @CallSuper onInflate( activity: Activity, attrs: AttributeSet, savedInstanceState: Bundle? )` This function is deprecated. See `onInflate`.
`Unit`	`@UiThread @CallSuper onInflate( context: Context, attrs: AttributeSet, savedInstanceState: Bundle? )` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`Unit`	`@MainThread @CallSuper onLowMemory()` This function is deprecated.
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`Boolean`	`@MainThread onOptionsItemSelected(item: MenuItem)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`@MainThread onOptionsMenuClosed(menu: Menu)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` Called by the system when the activity changes to and from picture-in-picture mode.
`Unit`	`@MainThread onPrepareOptionsMenu(menu: Menu)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`@MainThread onPrimaryNavigationFragmentChanged( isPrimaryNavigationFragment: Boolean )` Callback for when the primary navigation state of this Fragment has changed.
`Unit`	`@MainThread onSaveInstanceState(outState: Bundle)` 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.
`Unit`	`@MainThread @CallSuper onStop()` Called when the Fragment is no longer started.
`Unit`	`@MainThread onViewCreated(view: View, savedInstanceState: Bundle?)` Called immediately after `onCreateView` has returned, but before any saved state has been restored in to the view.
`Unit`	`@MainThread @CallSuper onViewStateRestored(savedInstanceState: Bundle?)` Called when all saved state has been restored into the view hierarchy of the fragment.
`Context?`	`peekAvailableContext()` Get the `Context` if it is currently available.
`Unit`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition` or `executePendingTransactions` has been called.
`Unit`	`postponeEnterTransition(duration: Long, timeUnit: TimeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `startPostponedEnterTransition`.
`ActivityResultLauncher<I!>`	`@MainThread <I, O> registerForActivityResult( contract: ActivityResultContract<I!, O!>, callback: ActivityResultCallback<O!> )` Register a request to `start an activity for result`, designated by the given `contract`.
`ActivityResultLauncher<I!>`	`@MainThread <I, O> registerForActivityResult( contract: ActivityResultContract<I!, O!>, registry: ActivityResultRegistry, callback: ActivityResultCallback<O!> )` Register a request to `start an activity for result`, designated by the given `contract`.
`Unit`	`registerForContextMenu(view: View)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`Unit`	`removeOnContextAvailableListener(listener: OnContextAvailableListener)` Remove a `OnContextAvailableListener` previously added via `addOnContextAvailableListener`.
`Unit`	`requestPermissions(permissions: Array<String!>, requestCode: Int)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`Bundle`	`requireArguments()` Return the arguments supplied when the fragment was instantiated.
`Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`FragmentManager`	`requireFragmentManager()` This function 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.
`Any`	`requireHost()` Return the host object of this fragment.
`Fragment`	`requireParentFragment()` Returns the parent Fragment containing this Fragment.
`View`	`requireView()` Get the root view for the fragment's layout (the one returned by `onCreateView`).
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` Sets whether the the exit transition and enter transition overlap or not.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` Sets whether the the return transition and reenter transition overlap or not.
`Unit`	`setArguments(args: Bundle?)` Supply the construction arguments for this fragment.
`Unit`	`setEnterSharedElementCallback(callback: SharedElementCallback?)` 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.
`Unit`	`setEnterTransition(transition: Any?)` Sets the Transition that will be used to move Views into the initial scene.
`Unit`	`setExitSharedElementCallback(callback: SharedElementCallback?)` 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.
`Unit`	`setExitTransition(transition: Any?)` 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.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` This function is deprecated. This method is no longer needed when using a `MenuProvider` to provide a `Menu` to your activity, which replaces `onCreateOptionsMenu` as the recommended way to provide a consistent, optionally `Lifecycle`-aware, and modular way to handle menu creation and item selection.
`Unit`	`setInitialSavedState(state: Fragment.SavedState?)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` Set a hint for whether this fragment's menu should be visible.
`Unit`	`setReenterTransition(transition: Any?)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`Unit`	`setRetainInstance(retain: Boolean)` This function is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`Unit`	`setReturnTransition(transition: Any?)` 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.
`Unit`	`setSharedElementEnterTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`Unit`	`setSharedElementReturnTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`Unit`	`setTargetFragment(fragment: Fragment?, requestCode: Int)` This function is deprecated. Instead of using a target fragment to pass results, the fragment requesting a result should use `setFragmentResultListener` to register a `FragmentResultListener` with a `requestKey` using its `parent fragment manager`.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` This function is deprecated. If you are manually calling this method, use `setMaxLifecycle` instead.
`Boolean`	`shouldShowRequestPermissionRationale(permission: String)` Gets whether you should show UI with rationale before requesting a permission.
`Unit`	`startActivity(intent: Intent)` Call `startActivity` from the fragment's containing Activity.
`Unit`	`startActivity(intent: Intent, options: Bundle?)` Call `startActivity` from the fragment's containing Activity.
`Unit`	`startActivityForResult(intent: Intent, requestCode: Int)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`startIntentSenderForResult( intent: IntentSender, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle? )` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition` was called.
`String`	`toString()`
`Unit`	`unregisterForContextMenu(view: View)` Prevents a context menu to be shown for the given view.

From androidx.lifecycle.HasDefaultViewModelProviderFactory

`CreationExtras!`	`getDefaultViewModelCreationExtras()` Returns the default `CreationExtras` that should be passed into `ViewModelProvider.Factory.create` when no overriding `CreationExtras` were passed to the `ViewModelProvider` constructors.
`ViewModelProvider.Factory!`	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors.

From androidx.lifecycle.LifecycleOwner

abstract Lifecycle!

getLifecycle()

Returns the Lifecycle of the provider.

From androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry!

getSavedStateRegistry()

The SavedStateRegistry owned by this SavedStateRegistryOwner

From android.view.View.OnCreateContextMenuListener

abstract Unit

onCreateContextMenu(
    p: ContextMenu!,
    p1: View!,
    p2: ContextMenu.ContextMenuInfo!
)

From androidx.lifecycle.ViewModelStoreOwner

abstract ViewModelStore!

getViewModelStore()

The owned ViewModelStore

Public constructors

SearchSupportFragment

Added in 1.1.0

SearchSupportFragment()

Public functions

createArgs

Added in 1.1.0

java-static fun createArgs(args: Bundle!, query: String!): Bundle!

Parameters
`args: Bundle!`	Bundle to use for the arguments, if null a new Bundle will be created.
`query: String!`	The search query, which is added to the bundle

createArgs

Added in 1.1.0

java-static fun createArgs(args: Bundle!, query: String!, title: String!): Bundle!

displayCompletions

Added in 1.1.0

fun displayCompletions(completions: Array<CompletionInfo!>!): Unit

Displays the completions shown by the IME. An application may provide a list of query completions that the system will show in the IME.

Parameters
`completions: Array<CompletionInfo!>!`	A list of completions to show in the IME. Setting to null or empty will clear the list.

displayCompletions

Added in 1.1.0

fun displayCompletions(completions: (Mutable)List<String!>!): Unit

Displays the completions shown by the IME. An application may provide a list of query completions that the system will show in the IME.

Parameters
`completions: (Mutable)List<String!>!`	A list of completions to show in the IME. Setting to null or empty will clear the list.

getBadgeDrawable

Added in 1.1.0

fun getBadgeDrawable(): Drawable!

Returns the badge drawable in the search bar.

getRecognizerIntent

Added in 1.1.0

fun getRecognizerIntent(): Intent!

Returns an intent that can be used to request speech recognition. Built from the base ACTION_RECOGNIZE_SPEECH plus extras:

EXTRA_LANGUAGE_MODEL set to LANGUAGE_MODEL_FREE_FORM
EXTRA_PARTIAL_RESULTS set to true
EXTRA_PROMPT set to the search bar hint text

For handling the intent returned from the service, see setSearchQuery.

getRowsSupportFragment

Added in 1.1.0

fun getRowsSupportFragment(): RowsSupportFragment!

Returns RowsSupportFragment that shows result rows. RowsSupportFragment is initialized after SearchSupportFragment.onCreateView().

Returns
`RowsSupportFragment!`	RowsSupportFragment that shows result rows.

getTitle

Added in 1.1.0

fun getTitle(): String!

Returns the title set in the search bar.

newInstance

Added in 1.1.0

java-static fun newInstance(query: String!): SearchSupportFragment!

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!`	A new SearchSupportFragment.

onCreate

fun onCreate(savedInstanceState: Bundle!): Unit

Called to do initial creation of a fragment. This is called after onAttach and before onCreateView.

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 androidx.lifecycle.LifecycleObserver on the activity's Lifecycle, removing it when it receives the CREATED callback.

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

fun onCreateView(
    inflater: LayoutInflater,
    container: ViewGroup?,
    savedInstanceState: Bundle?
): View?

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 onCreate and onViewCreated.

A default View can be returned by calling Fragment 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 onViewCreated.

If you return a View from here, you will later be called in 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?`	Return the View for the fragment's UI, or null.

onDestroy

fun onDestroy(): Unit

Called when the fragment is no longer in use. This is called after onStop and before onDetach.

onDestroyView

fun onDestroyView(): Unit

Called when the view previously created by onCreateView 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 onStop and before onDestroy. It is called regardless of whether onCreateView 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

fun onPause(): Unit

Called when the Fragment is no longer resumed. This is generally tied to Activity.onPause of the containing Activity's lifecycle.

onRequestPermissionsResult

fun onRequestPermissionsResult(
    requestCode: Int,
    permissions: Array<String!>!,
    grantResults: IntArray<Int>!
): Unit

Callback for the result from requesting permissions. This method is invoked for every call on requestPermissions.

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`.
`permissions: Array<String!>!`	The requested permissions. Never null.
`grantResults: IntArray<Int>!`	The grant results for the corresponding permissions which is either `PERMISSION_GRANTED` or `PERMISSION_DENIED`. Never null.

See also
`requestPermissions`

onResume

fun onResume(): Unit

Called when the fragment is visible to the user and actively running. This is generally tied to Activity.onResume of the containing Activity's lifecycle.

onStart

fun onStart(): Unit

Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle.

setBadgeDrawable

Added in 1.1.0

fun setBadgeDrawable(drawable: Drawable!): Unit

Sets the badge drawable that will be shown inside the search bar next to the title.

Added in 1.1.0

fun setOnItemViewClickedListener(listener: OnItemViewClickedListener!): Unit

Sets an item clicked listener for the results.

Parameters
`listener: OnItemViewClickedListener!`	The item clicked listener to be invoked when an item in the search results is clicked.

Added in 1.1.0

fun setOnItemViewSelectedListener(listener: OnItemViewSelectedListener!): Unit

Sets an item selection listener for the results.

Parameters
`listener: OnItemViewSelectedListener!`	The item selection listener to be invoked when an item in the search results is selected.

Added in 1.1.0

fun setSearchAffordanceColors(colors: SearchOrbView.Colors!): Unit

Sets background color of not-listening state search orb.

Parameters
`colors: SearchOrbView.Colors!`	SearchOrbView.Colors.

Added in 1.1.0

fun setSearchAffordanceColorsInListening(colors: SearchOrbView.Colors!): Unit

Sets background color of listening state search orb.

Parameters
`colors: SearchOrbView.Colors!`	SearchOrbView.Colors.

setSearchQuery

Added in 1.1.0

fun setSearchQuery(intent: Intent!, submit: Boolean): Unit

Sets the text of the search query based on the EXTRA_RESULTS in the given intent, and optionally submit the query. If more than one result is present in the results list, the first will be used.

Parameters
`intent: Intent!`	Intent received from a speech recognition service.
`submit: Boolean`	Whether to submit the query.

setSearchQuery

Added in 1.1.0

fun setSearchQuery(query: String!, submit: Boolean): Unit

Sets the text of the search query and optionally submits the query. Either onQueryTextChange or onQueryTextSubmit will be called on the provider if it is set.

Parameters
`query: String!`	The search query to set.
`submit: Boolean`	Whether to submit the query.

setSearchResultProvider

Added in 1.1.0

fun setSearchResultProvider(
    searchResultProvider: SearchSupportFragment.SearchResultProvider!
): Unit

Sets the search provider that is responsible for returning results for the search query.

Added in 1.1.0

Deprecated in 1.1.0

fun setSpeechRecognitionCallback(callback: SpeechRecognitionCallback!): Unit

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

fun setTitle(title: String!): Unit

Sets the title string to be be shown in an empty search bar. The title may be placed in a call-to-action, such as "Search title" or "Speak to search title".

startRecognition

Added in 1.1.0

fun startRecognition(): Unit

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.

SearchSupportFragment

Summary

Nested types

Public constructors

Public functions

Inherited functions

Public constructors

SearchSupportFragment

Public functions

createArgs

createArgs

displayCompletions

displayCompletions

getBadgeDrawable

getRecognizerIntent

getRowsSupportFragment

getTitle

newInstance

onCreate

onCreateView

onDestroy

onDestroyView

onPause

onRequestPermissionsResult

onResume

onStart

setBadgeDrawable

setOnItemViewClickedListener

setOnItemViewSelectedListener

setSearchAffordanceColors

setSearchAffordanceColorsInListening

setSearchQuery

setSearchQuery

setSearchResultProvider

setSpeechRecognitionCallback

setTitle

startRecognition