MessageTemplate
@CarProtocol
class MessageTemplate : Template
A template for displaying a message and associated actions.
Template Restrictions In regards to template refreshes, as described inonGetTemplate, this template is considered a refresh of a previous one if the title and messages have not changed.
Summary
Nested types |
|---|
class MessageTemplate.BuilderA builder of |
Public functions |
|
|---|---|
Boolean |
|
ActionStrip? |
@RequiresCarApi(value = 2)This function is deprecated. use |
(Mutable)List<Action!> |
Returns the list of actions to display in the template. |
CarText? |
Returns a debug message to display in the template or |
Header? |
Returns the |
Action? |
This function is deprecated. use |
CarIcon? |
getIcon()Returns the icon to display in the template or |
CarText |
Returns the message to display in the template. |
CarText? |
This function is deprecated. use |
Int |
hashCode() |
Boolean |
@RequiresCarApi(value = 2)Returns whether the template is loading. |
String |
toString() |
Public functions
@RequiresCarApi(value = 2)
fungetActionStrip(): ActionStrip?
Returns the ActionStrip for this template or null if not set.
getActions
fun getActions(): (Mutable)List<Action!>
Returns the list of actions to display in the template.
| See also | |
|---|---|
addAction |
getDebugMessage
fun getDebugMessage(): CarText?
Returns a debug message to display in the template or null if not set.
| See also | |
|---|---|
setDebugMessage |
|
setDebugMessage |
getHeader
fun getHeader(): Header?
Returns the Header to display in this template.
This method was introduced in API 7, but is backwards compatible even if the client is using API 6 or below.
| See also | |
|---|---|
setHeader |
fungetHeaderAction(): Action?
Returns the Action that is set to be displayed in the header of the template, or null if not set.
getIcon
fun getIcon(): CarIcon?
Returns the icon to display in the template or null if not set.
| See also | |
|---|---|
setIcon |
getMessage
fun getMessage(): CarText
Returns the message to display in the template.
| See also | |
|---|---|
Builder |
isLoading
@RequiresCarApi(value = 2)
fun isLoading(): Boolean
Returns whether the template is loading.
| See also | |
|---|---|
setLoading |