SearchSupportFragment
open 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 .
A SpeechRecognizer object will be created for which your application will need to declare android.permission.RECORD_AUDIO in AndroidManifest file. If app's target version is >= 23 and the device version is >= 23, a permission dialog will show first time using speech recognition. 0 will be used as requestCode in requestPermissions() call. setSpeechRecognitionCallback(SpeechRecognitionCallback)
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 classes | |
---|---|
abstract |
Search API to be provided by the application. |
Public constructors | |
---|---|
<init>() A fragment to handle searches. |
Public methods | |
---|---|
open static Bundle! |
createArgs(args: Bundle!, query: String!) |
open static Bundle! |
createArgs(args: Bundle!, query: String!, title: String!) |
open Unit |
displayCompletions(completions: MutableList<String!>!) Displays the completions shown by the IME. |
open Unit |
displayCompletions(completions: Array<CompletionInfo!>!) Displays the completions shown by the IME. |
open Drawable! |
Returns the badge drawable in the search bar. |
open Intent! |
Returns an intent that can be used to request speech recognition. |
open RowsSupportFragment! |
Returns RowsSupportFragment that shows result rows. |
open String! |
getTitle() Returns the title set in the search bar. |
open static SearchSupportFragment! |
newInstance(query: String!) Creates a search fragment with a given search query. |
open Unit | |
open View? |
onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?) |
open Unit | |
open Unit |
onPause() |
open Unit |
onRequestPermissionsResult(requestCode: Int, permissions: Array<String!>, grantResults: IntArray) |
open Unit |
onResume() |
open Unit |
onStart() |
open Unit |
setBadgeDrawable(drawable: Drawable!) Sets the badge drawable that will be shown inside the search bar next to the title. |
open Unit |
Sets an item clicked listener for the results. |
open Unit |
Sets an item selection listener for the results. |
open Unit |
Sets background color of not-listening state search orb. |
open Unit |
Sets background color of listening state search orb. |
open Unit |
setSearchQuery(query: String!, submit: |