PlaceListMapTemplate.Builder

Builder()

Returns an empty Builder instance.

fun build(): PlaceListMapTemplate

Constructs the template defined by this builder.

If neither header Action nor title have been set on the template, the header is hidden.

fun setActionStrip(actionStrip: ActionStrip): PlaceListMapTemplate.Builder

Sets the ActionStrip for this template.

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

The Action buttons in Map Based Template are automatically adjusted based on the screen size. On narrow width screen, icon Actions show by default. If no icon specify, showing title Actions instead. On wider width screen, title Actions show by default. If no title specify, showing icon Actions instead.

fun setAnchor(anchor: Place): PlaceListMapTemplate.Builder

Sets the anchor maker on the map.

An anchor marker will not be displayed unless set with this method.

The anchor marker is displayed differently from other markers by the host.

If not null, an anchor marker will be shown at the specified CarLocation on the map. The camera will adapt to always have the anchor marker visible within its viewport, along with other places' markers from Row that are currently visible in the Pane. This can be used to provide a reference point on the map (e.g. the center of a search region) as the user pages through the Pane's markers, for example.

fun setCurrentLocationEnabled(isEnabled: Boolean): PlaceListMapTemplate.Builder

Sets whether to show the current location in the map.

The map template will show the user's current location on the map.

This functionality requires the app to have either the ACCESS_FINE_LOCATION or ACCESS_COARSE_LOCATION permission. When isEnabled is true, the host may receive location updates from the app in order to show the user's current location.

fun setHeaderAction(headerAction: Action): PlaceListMapTemplate.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.

fun setItemList(itemList: ItemList): PlaceListMapTemplate.Builder

Sets an ItemList to show in a list view along with the map.

Unless set with this method, the template will not show an item list.

To show a marker corresponding to a point of interest represented by a row, set the Place instance via setMetadata. The host will display the PlaceMarker in both the map and the list view as the row becomes visible.

Images of type IMAGE_TYPE_LARGE are not allowed in this template.

Rows are not allowed to have both and an image and a place marker.

All non-browsable rows must have a DistanceSpan attached to either its title or texts to indicate the distance of the point of interest from the current location. A row is browsable when it's configured like so with setBrowsable.

fun setLoading(isLoading: Boolean): PlaceListMapTemplate.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 ItemList contents added via setItemList.

@RequiresCarApi(value = 5)
fun setOnContentRefreshListener(
    onContentRefreshListener: OnContentRefreshListener
): PlaceListMapTemplate.Builder

Sets the OnContentRefreshListener to call when the user requests for the list contents to be refreshed in this template.

When the listener is triggered, an app can send a new PlaceListMapTemplate, for example, to show a new set of point-of-interests based on the current user location, without the car host counting it against the template quota described in onGetTemplate.

fun setTitle(title: CarText): PlaceListMapTemplate.Builder

Sets the title of the template, with support for multiple length variants.

Only DistanceSpans and DurationSpans are supported in the input string.

fun setTitle(title: CharSequence): PlaceListMapTemplate.Builder

Sets the title of the template.

Only DistanceSpans and DurationSpans are supported in the input string.