Android APIs
public static interface

SearchFragment.SearchResultProvider

android.support.v17.leanback.app.SearchFragment.SearchResultProvider

Class Overview

Search API to be provided by the application.

Summary

Public Methods
abstract ObjectAdapter getResultsAdapter()

Method invoked some time prior to the first call to onQueryTextChange to retrieve an ObjectAdapter that will contain the results to future updates of the search query.

abstract boolean onQueryTextChange(String newQuery)

Method invoked when the search query is updated.

abstract boolean onQueryTextSubmit(String query)
Method invoked when the search query is submitted, either by dismissing the keyboard, pressing search or next on the keyboard or when voice has detected the end of the query.

Public Methods

public abstract ObjectAdapter getResultsAdapter ()

Method invoked some time prior to the first call to onQueryTextChange to retrieve an ObjectAdapter that will contain the results to future updates of the search query.

As results are retrieved, the application should use the data set notification methods on the ObjectAdapter to instruct the SearchFragment to update the results.

Returns
  • ObjectAdapter The result object adapter.

public abstract boolean onQueryTextChange (String newQuery)

Method invoked when the search query is updated.

This is called as soon as the query changes; it is up to the application to add a delay before actually executing the queries if needed.

This method might not always be called before onQueryTextSubmit gets called, in particular for voice input.

Parameters
newQuery The current search query.
Returns
  • whether the results changed as a result of the new query.

public abstract boolean onQueryTextSubmit (String query)

Method invoked when the search query is submitted, either by dismissing the keyboard, pressing search or next on the keyboard or when voice has detected the end of the query.

Parameters
query The query entered.
Returns
  • whether the results changed as a result of the query.