Banner


@ExperimentalCarApi
@CarProtocol
@RequiresCarApi(value = 9)
class Banner : Item


A banner element that's meant to be visually distinct from other normal elements on the screen.

For example, a banner can be used to tell the user whether the app is running in an online vs offline mode, or promote a specific event or announcement.

Summary

Nested types

A builder of Banner.

Public functions

Boolean
equals(other: Any?)
Background?

Returns the background of the banner.

(Mutable)List<Action!>

Returns the list of actions below the title and subtitle.

OnClickDelegate?

Returns the OnClickDelegate to be called back when the banner is clicked.

CarText?

Returns the subtitle of the banner.

CarText?

Returns the title of the banner.

Int
String

Public functions

equals

fun equals(other: Any?): Boolean

getBackground

Added in 1.9.0-alpha01
fun getBackground(): Background?

Returns the background of the banner.

See also
setBackground

getBelowActions

Added in 1.8.0
fun getBelowActions(): (Mutable)List<Action!>

Returns the list of actions below the title and subtitle.

See also
addBelowAction

getOnClickDelegate

Added in 1.8.0
fun getOnClickDelegate(): OnClickDelegate?

Returns the OnClickDelegate to be called back when the banner is clicked.

getSubtitle

Added in 1.8.0
fun getSubtitle(): CarText?

Returns the subtitle of the banner.

The title is automatically truncated if it's too long; however, shorter variants can be added via addVariant.

See also
setSubtitle

getTitle

Added in 1.8.0
fun getTitle(): CarText?

Returns the title of the banner.

The title is automatically truncated if it's too long; however, shorter variants can be added via addVariant.

See also
setTitle

hashCode

fun hashCode(): Int

toString

fun toString(): String