MessageTemplate

@CarProtocol
class MessageTemplate : Template

A template for displaying a message and associated actions.

Template Restrictions In regards to template refreshes, as described in onGetTemplate, this template is considered a refresh of a previous one if the title and messages have not changed.

Summary

Nested types

A builder of MessageTemplate.

Public functions
Boolean
equals(other: Any?)
ActionStrip?

This function is deprecated.

use getEndHeaderActions instead.
(Mutable)List<Action!>

Returns the list of actions to display in the template.
CarText?

Returns a debug message to display in the template or null if not set.
Header?

Returns the Header to display in this template.
Action?

This function is deprecated.

use getStartHeaderAction instead.
CarIcon?

Returns the icon to display in the template or null if not set.
CarText

Returns the message to display in the template.
CarText?

This function is deprecated.

use getTitle instead.
Int
Boolean
@RequiresCarApi(value = 2)
isLoading()

Returns whether the template is loading.
String

Public functions

equals

fun equals(other: Any?): Boolean

getActionStrip

Added in 1.1.0
Deprecated in 1.7.0-alpha02
@RequiresCarApi(value = 2)
fun getActionStrip(): ActionStrip?

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

getActions

Added in 1.0.0
fun getActions(): (Mutable)List<Action!>

Returns the list of actions to display in the template.

See also
addAction

getDebugMessage

Added in 1.0.0
fun getDebugMessage(): CarText?

Returns a debug message to display in the template or null if not set.

See also
setDebugMessage
setDebugMessage

getHeader

Added in 1.7.0-alpha02
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

getHeaderAction

Added in 1.0.0
Deprecated in 1.7.0-alpha02
fun getHeaderAction(): Action?

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

getIcon

Added in 1.0.0
fun getIcon(): CarIcon?

Returns the icon to display in the template or null if not set.

See also
setIcon

getMessage

Added in 1.0.0
fun getMessage(): CarText

Returns the message to display in the template.

See also
Builder

getTitle

Added in 1.0.0
Deprecated in 1.7.0-alpha02
fun getTitle(): CarText?

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

hashCode

fun hashCode(): Int

isLoading

Added in 1.1.0
@RequiresCarApi(value = 2)
fun isLoading(): Boolean

Returns whether the template is loading.

See also
setLoading

toString

fun toString(): String