SearchTemplate
@CarProtocol
class SearchTemplate : Template
A model that allows the user to enter text searches, and can display results in a list.
Template Restrictions In regards to template refreshes, as described inonGetTemplate, this template supports any content changes as refreshes. This allows apps to interactively update the search results as the user types without the templates being counted against the quota.
Summary
Nested types |
|---|
class SearchTemplate.BuilderA builder of |
interface SearchTemplate.SearchCallbackA listener for search updates. |
Public functions |
|
|---|---|
Boolean |
|
ActionStrip? |
Returns the |
Action? |
Returns the |
String? |
Returns the optional initial search text. |
ItemList? |
Returns the |
SearchCallbackDelegate |
Returns the |
String? |
Returns the optional search hint. |
Int |
hashCode() |
Boolean |
Returns whether the template is loading. |
Boolean |
Returns whether to show the keyboard by default. |
String |
toString() |
Public functions
getActionStrip
fun getActionStrip(): ActionStrip?
Returns the ActionStrip for this template or null if not set.
| See also | |
|---|---|
setActionStrip |
getHeaderAction
fun getHeaderAction(): Action?
Returns the Action that is set to be displayed in the header of the template, or null if not set.
| See also | |
|---|---|
setHeaderAction |
getInitialSearchText
fun getInitialSearchText(): String?
Returns the optional initial search text.
| See also | |
|---|---|
setInitialSearchText |
getItemList
fun getItemList(): ItemList?
Returns the ItemList for search results or null if not set.
| See also | |
|---|---|
getItemList |
getSearchCallbackDelegate
fun getSearchCallbackDelegate(): SearchCallbackDelegate
Returns the SearchCallbackDelegate for search callbacks.
getSearchHint
fun getSearchHint(): String?
Returns the optional search hint.
| See also | |
|---|---|
setSearchHint |
isLoading
fun isLoading(): Boolean
Returns whether the template is loading.
| See also | |
|---|---|
setLoading |
isShowKeyboardByDefault
fun isShowKeyboardByDefault(): Boolean
Returns whether to show the keyboard by default.
| See also | |
|---|---|
setShowKeyboardByDefault |