# SearchBar.SearchBarListener

# SearchBar.SearchBarListener

Artifact:[androidx.leanback:leanback](https://developer.android.com/jetpack/androidx/releases/leanback)  
[View Source](https://cs.android.com/search?q=file:androidx/leanback/widget/SearchBar.java+class:androidx.leanback.widget.SearchBar.SearchBarListener)  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/leanback/widget/SearchBar.SearchBarListener "View this page in Java")

<br />

```
interface SearchBar.SearchBarListener
```

<br />

*** ** * ** ***

Interface for receiving notification of search query changes.

## Summary

|                             ### Public functions                              |
|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onKeyboardDismiss](https://developer.android.com/reference/kotlin/androidx/leanback/widget/SearchBar.SearchBarListener#onKeyboardDismiss(java.lang.String))`(query: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!)` Method invoked when the IME is being dismissed.                       |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onSearchQueryChange](https://developer.android.com/reference/kotlin/androidx/leanback/widget/SearchBar.SearchBarListener#onSearchQueryChange(java.lang.String))`(query: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!)` Method invoked when the search bar detects a change in the query. |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onSearchQuerySubmit](https://developer.android.com/reference/kotlin/androidx/leanback/widget/SearchBar.SearchBarListener#onSearchQuerySubmit(java.lang.String))`(query: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!)` Method invoked when the search query is submitted.                |

## Public functions

### onKeyboardDismiss

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun onKeyboardDismiss(query: String!): Unit
```

Method invoked when the IME is being dismissed.  

|                                          Parameters                                           |
|-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|
| `query: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!` | The query set in the search bar at the time the IME is being dismissed. |

### onSearchQueryChange

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun onSearchQueryChange(query: String!): Unit
```

Method invoked when the search bar detects a change in the query.  

|                                          Parameters                                           |
|-----------------------------------------------------------------------------------------------|-------------------------|
| `query: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!` | The current full query. |

### onSearchQuerySubmit

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun onSearchQuerySubmit(query: String!): Unit
```

Method invoked when the search query is submitted.

This method can be called without a preceeding onSearchQueryChange, in particular in the case of a voice input.  

|                                          Parameters                                           |
|-----------------------------------------------------------------------------------------------|----------------------------|
| `query: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!` | The query being submitted. |