SearchTemplate.Builder

Builder(callback: SearchTemplate.SearchCallback)

Returns a new instance of a Builder with the input SearchCallback.

Note that the callback relates to UI events and will be executed on the main thread using getMainLooper.

fun build(): SearchTemplate

Constructs the SearchTemplate model.

fun setActionStrip(actionStrip: ActionStrip): SearchTemplate.Builder

Sets the ActionStrip for this template.

Unless set with this method, the template will not have an action strip.

Requirements This template allows up to 2 Actions in its ActionStrip. Of the 2 allowed Actions, one of them can contain a title as set via setTitle. Otherwise, only Actions with icons are allowed.

fun setHeaderAction(headerAction: Action): SearchTemplate.Builder

Sets the Action that will be displayed in the header of the template.

Unless set with this method, the template will not have a header action.

Requirements This template only supports either one of APP_ICON and BACK as a header Action.

fun setInitialSearchText(initialSearchText: String): SearchTemplate.Builder

Sets the initial search text to display in the search box.

fun setItemList(itemList: ItemList): SearchTemplate.Builder

Sets the ItemList to show for search results.

The list will be shown below the search box, allowing users to click on individual search results.

Requirements The number of items in the ItemList should be smaller or equal than the limit provided by CONTENT_LIMIT_TYPE_LIST. The host will ignore any items over that limit. The list itself cannot be selectable as set via setOnSelectedListener. Each Row can add up to 2 lines of texts via addText and cannot contain a Toggle.

fun setLoading(isLoading: Boolean): SearchTemplate.Builder

Sets whether the template is in a loading state.

If set to true, the UI will display a loading indicator where the list content would be otherwise. The caller is expected to call invalidate and send the new template content to the host once the data is ready. If set to false, the UI shows the contents added via setItemList.

fun setSearchHint(searchHint: String): SearchTemplate.Builder

Sets the text hint to display in the search box when it is empty.

The host will use a default search hint if not set with this method.

This is not the actual search text, and will disappear if user types any value into the search.

If a non empty text is set via setInitialSearchText, the searchHint will not show, unless the user erases the search text.

fun setShowKeyboardByDefault(showKeyboardByDefault: Boolean): SearchTemplate.Builder

Sets if the keyboard should be displayed by default, instead of waiting until user interacts with the search box.

Defaults to true.