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?

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

(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.

Action?

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

CarIcon?

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

CarText

Returns the message to display in the template.

CarText?

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

Int
Boolean
@RequiresCarApi(value = 2)
isLoading()

Returns whether the template is loading.

String

Public functions

equals

Added in 1.4.0-rc02
fun equals(other: Any?): Boolean

getActionStrip

Added in 1.1.0
@RequiresCarApi(value = 2)
fun getActionStrip(): ActionStrip?

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

See also
setActionStrip

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.

getHeaderAction

Added in 1.0.0
fun getHeaderAction(): Action?

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

See also
setHeaderAction

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
fun getTitle(): CarText?

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

See also
setTitle

hashCode

Added in 1.4.0-rc02
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

Added in 1.4.0-rc02
fun toString(): String