PlaceListMapTemplate

@CarProtocol
class PlaceListMapTemplate : Template

A template that displays a map along with a list of places.

The map can display markers corresponding to the places in the list. See setItemList for details.

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 number of rows and the title (not counting spans) of each row between the previous and new ItemLists have not changed.
  • The template is sent in response to a user-initiated content refresh request. (see setOnContentRefreshListener.

Summary

Nested types

A builder of PlaceListMapTemplate.

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

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

Returns the Place instance to display as an anchor in the map.
Action?

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

Returns the ItemList instance with the list of items to display in the template, or null if not set.
OnContentRefreshDelegate?

Returns the OnContentRefreshDelegate to be called when the user requests for content refresh for this template.
CarText?

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

Returns whether the template is loading.
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

getAnchor

Added in 1.0.0
fun getAnchor(): Place?

Returns the Place instance to display as an anchor in the map.

See also
setAnchor

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

getItemList

Added in 1.0.0
fun getItemList(): ItemList?

Returns the ItemList instance with the list of items to display in the template, or null if not set.

See also
setItemList

getOnContentRefreshDelegate

Added in 1.2.0
@RequiresCarApi(value = 5)
fun getOnContentRefreshDelegate(): OnContentRefreshDelegate?

Returns the OnContentRefreshDelegate to be called when the user requests for content refresh for this template.

See also
setOnContentRefreshListener

getTitle

Added in 1.0.0
fun getTitle(): CarText?

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

See also
setTitle

hashCode

fun hashCode(): Int

isCurrentLocationEnabled

Added in 1.0.0
fun isCurrentLocationEnabled(): Boolean

isLoading

Added in 1.0.0
fun isLoading(): Boolean

Returns whether the template is loading.

See also
setLoading

toString

fun toString(): String