SignInTemplate

public final class SignInTemplate
extends Object implements Template

java.lang.Object
   ↳ androidx.car.app.model.signin.SignInTemplate


A template that can be used to create a sign-in flow.

Template Restrictions

This template is considered the start of a new task and thus restarts the template quota when an app reaches this template. If this template is sent consecutively, subsequent SignInTemplates will not trigger a quota reset, as they will be considered part of the same sign-in flow. The quota will be reduced for these templates unless they are considered a refresh of a previous one. This template is considered a refresh of a previous one if:
  • The template title and the sign-in method have not changed.

Summary

Nested classes

class SignInTemplate.Builder

A builder of SignInTemplate

interface SignInTemplate.SignInMethod

One of the possible sign in methods that can be set on a SignInTemplate

Public methods

boolean equals(Object other)
ActionStrip getActionStrip()

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

List<Action> getActions()

Returns the list of Actions displayed alongside the SignInTemplate.SignInMethod in this template.

CarText getAdditionalText()

Returns any additional text that needs to be displayed in the template or null if not set.

Action getHeaderAction()

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

CarText getInstructions()

Returns a text containing instructions on how to sign in or null if not set.

SignInTemplate.SignInMethod getSignInMethod()

Returns the sign-in method of this template.

CarText getTitle()

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

int hashCode()
String toString()

Inherited methods

Public methods

equals

public boolean equals (Object other)

Parameters
other Object

Returns
boolean

getActionStrip

public ActionStrip getActionStrip ()

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

Returns
ActionStrip

getActions

public List<Action> getActions ()

Returns the list of Actions displayed alongside the SignInTemplate.SignInMethod in this template.

Returns
List<Action>

getAdditionalText

public CarText getAdditionalText ()

Returns any additional text that needs to be displayed in the template or null if not set.

Returns
CarText

getHeaderAction

public Action getHeaderAction ()

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

Returns
Action

getInstructions

public CarText getInstructions ()

Returns a text containing instructions on how to sign in or null if not set.

Returns
CarText

getSignInMethod

public SignInTemplate.SignInMethod getSignInMethod ()

Returns the sign-in method of this template.

Returns
SignInTemplate.SignInMethod

getTitle

public CarText getTitle ()

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

Returns
CarText

hashCode

public int hashCode ()

Returns
int

toString

public String toString ()

Returns
String