ListTemplate

@CarProtocol
public final class ListTemplate implements Template

A template representing a list of items.

Template Restrictions In regards to template refreshes, as described in onGetTemplate, this template is considered a refresh of a previous one if:
  • The previous template is in a loading state (see setLoading}, or
  • The template title has not changed, and the ItemList structure between the templates have not changed. This means that if the previous template has multiple ItemList sections, the new template must have the same number of sections with the same headers. Further, the number of rows and the title (not counting spans) of each row must not have changed.
  • For rows that contain a Toggle, updates to the title are also allowed if the toggle state has changed between the previous and new templates.

Summary

Nested types
public final class ListTemplate.Builder

A builder of ListTemplate.

Public methods
boolean
@Nullable ActionStrip

This method is deprecated.

use getEndHeaderActions instead.
@NonNull List<Action>
@RequiresCarApi(value = 6)
getActions()

Returns the list of additional actions.
@Nullable Header

Returns the Header to display in this template.
@Nullable Action

This method is deprecated.

use getStartHeaderAction instead.
@NonNull List<SectionedItemList>

Returns the list of SectionedItemList instances to be displayed in the template.
@Nullable ItemList

Returns the ItemList instance containing the list of items to display or null if one hasn't been set.
@Nullable CarText

This method is deprecated.

use getTitle instead.
int
boolean

Returns whether the template is loading.
@NonNull ListTemplate.Builder

Creates and returns a new Builder initialized with this ListTemplate's data.
@NonNull String

Public methods

equals

public boolean equals(@Nullable Object other)

getActionStrip

Added in 1.0.0
Deprecated in 1.7.0
public @Nullable ActionStrip getActionStrip()

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

See also
setActionStrip

getActions

Added in 1.4.0
@RequiresCarApi(value = 6)
public @NonNull List<Action> getActions()

Returns the list of additional actions.

See also
addAction

getHeader

Added in 1.7.0
public @Nullable Header getHeader()

Returns the Header to display in this template.

This method was introduced in API 7, but is backwards compatible even if the client is using API 6 or below.

See also
setHeader

getHeaderAction

Added in 1.0.0
Deprecated in 1.7.0
public @Nullable Action getHeaderAction()

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

See also
setHeaderAction

getSectionedLists

Added in 1.0.0
public @NonNull List<SectionedItemList> getSectionedLists()

Returns the list of SectionedItemList instances to be displayed in the template.

See also
addSectionedList

getSingleList

Added in 1.0.0
public @Nullable ItemList getSingleList()

Returns the ItemList instance containing the list of items to display or null if one hasn't been set.

See also
setSingleList

getTitle

Added in 1.0.0
Deprecated in 1.7.0
public @Nullable CarText getTitle()

Returns the title of the template or null if not set.

See also
setTitle

hashCode

public int hashCode()

isLoading

Added in 1.0.0
public boolean isLoading()

Returns whether the template is loading.

See also
setLoading

toBuilder

Added in 1.3.0
@ExperimentalCarApi
public @NonNull ListTemplate.Builder toBuilder()

Creates and returns a new Builder initialized with this ListTemplate's data.

toString

public @NonNull String toString()