SignInTemplate

Artifact: androidx.car.app:app

View Source

Added in 1.0.0

---

Kotlin |Java

@RequiresCarApi(value = 2)
public final class SignInTemplate implements Template

---

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

Template Restrictions This template's body is only available to the user while the car is parked and does not count against the template quota.

See also
onGetTemplate

Summary

Nested types
@RequiresCarApi(value = 2) public final class SignInTemplate.Builder A builder of SignInTemplate.
public interface SignInTemplate.SignInMethod One of the possible sign in methods that can be set on a SignInTemplate.

Public methods
boolean	equals(Object other)
@Nullable ActionStrip	getActionStrip() Returns the ActionStrip for this template or null if not set.
@NonNull List<Action>	getActions() Returns the list of Actions displayed alongside the SignInMethod in this template.
@Nullable CarText	getAdditionalText() Returns any additional text that needs to be displayed in the template or null if not set.
@Nullable Action	getHeaderAction() Returns the Action that is set to be displayed in the header of the template or null if not set.
@Nullable CarText	getInstructions() Returns a text containing instructions on how to sign in or null if not set.
@NonNull SignInTemplate.SignInMethod	getSignInMethod() Returns the sign-in method of this template.
@Nullable CarText	getTitle() Returns the title of the template or null if not set.
int	hashCode()
boolean	isLoading() Returns whether the template is loading.
@NonNull String	toString()

Public methods

equals

public boolean equals(Object other)

getActionStrip

Added in 1.0.0

public @Nullable ActionStrip getActionStrip()

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

See also
setActionStrip

getActions

Added in 1.0.0

public @NonNull List<Action> getActions()

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

See also
addAction

getAdditionalText

Added in 1.0.0

public @Nullable CarText getAdditionalText()

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

See also
setAdditionalText

getHeaderAction

Added in 1.0.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

getInstructions

Added in 1.0.0

public @Nullable CarText getInstructions()

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

See also
setInstructions

getSignInMethod

Added in 1.0.0

public @NonNull SignInTemplate.SignInMethod getSignInMethod()

Returns the sign-in method of this template.

See also
Builder

getTitle

Added in 1.0.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.1.0

public boolean isLoading()

Returns whether the template is loading.

See also
setLoading

toString

public @NonNull String toString()