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 in onGetTemplate, 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

A builder of SearchTemplate.

A listener for search updates.

Public functions
Boolean
equals(other: Any?)
ActionStrip?

Returns the ActionStrip for this template or null if not set.
Action?

Returns the Action that is set to be displayed in the header of the template, or null if not set.
String?

Returns the optional initial search text.
ItemList?

Returns the ItemList for search results or null if not set.
SearchCallbackDelegate

Returns the SearchCallbackDelegate for search callbacks.
String?

Returns the optional search hint.
Int
Boolean

Returns whether the template is loading.
Boolean

Returns whether to show the keyboard by default.
String

Public functions

equals

fun equals(other: Any?): Boolean

getActionStrip

Added in 1.0.0
fun getActionStrip(): ActionStrip?

Returns the ActionStrip for this template or null if not set.

See also
setActionStrip

getHeaderAction

Added in 1.0.0
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

Added in 1.0.0
fun getInitialSearchText(): String?

Returns the optional initial search text.

See also
setInitialSearchText

getItemList

Added in 1.0.0
fun getItemList(): ItemList?

Returns the ItemList for search results or null if not set.

See also
getItemList

getSearchCallbackDelegate

Added in 1.0.0
fun getSearchCallbackDelegate(): SearchCallbackDelegate

Returns the SearchCallbackDelegate for search callbacks.

getSearchHint

Added in 1.0.0
fun getSearchHint(): String?

Returns the optional search hint.

See also
setSearchHint

hashCode

fun hashCode(): Int

isLoading

Added in 1.0.0
fun isLoading(): Boolean

Returns whether the template is loading.

See also
setLoading

isShowKeyboardByDefault

Added in 1.0.0
fun isShowKeyboardByDefault(): Boolean

Returns whether to show the keyboard by default.

See also
setShowKeyboardByDefault

toString

fun toString(): String