TemplateWrapper

public final class TemplateWrapper
extends Object

java.lang.Object
   ↳ androidx.car.app.model.TemplateWrapper


A wrapper for mapping a Template with a unique ID used for implementing task flow restrictions.

This is what is sent to the host, so that the host can determine whether the template is a new template (e.g. a step counts toward the task limit), or an existing template update (e.g. a refresh that does not count towards the task limit), by checking whether the ID have changed.

This class is for use by host implementations and not by apps.

Summary

Public methods

static TemplateWrapper copyOf(TemplateWrapper source)

Creates a copy of the given TemplateWrapper.

int getCurrentTaskStep()

Retrieves the current task step that the template is in.

String getId()

Returns the ID associated with the wrapped Template.

Template getTemplate()

Returns the wrapped Template.

List<TemplateInfo> getTemplateInfosForScreenStack()

Returns a TemplateInfo for the last returned template for each of the screens in the screen stack managed by the screen manager.

boolean isRefresh()

Returns true if the template is a refresh for the previous template.

void setCurrentTaskStep(int currentTaskStep)

Sets the current task step that the template is in.

void setId(String id)

Updates the ID associated with the wrapped Template.

void setRefresh(boolean isRefresh)

Sets whether the template is a refresh of the current template.

void setTemplate(Template template)

Updates the Template this TemplateWrapper instance wraps.

String toString()
static TemplateWrapper wrap(Template template)

Creates a TemplateWrapper instance with the given Template.

static TemplateWrapper wrap(Template template, String id)

Creates a TemplateWrapper instance with the given <