com.smartdevicelink.managers.screen

Class AlertView.Builder

java.lang.Object

com.smartdevicelink.managers.screen.AlertView.Builder

Enclosing class:

AlertView

public static class AlertView.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AlertView	build()
AlertView.Builder	setAudio(AlertAudioData audio) Text spoken, file(s) played, and/or tone played when the alert appears
AlertView.Builder	setDefaultTimeOut(int defaultTimeOut) Set this to change the default timeout for all alerts.
AlertView.Builder	setIcon(SdlArtwork icon) An artwork that will be displayed when the icon appears.
AlertView.Builder	setSecondaryText(String secondaryText) The secondary line of text for display on the alert.
AlertView.Builder	setShowWaitIndicator(boolean showWaitIndicator) If supported, the alert GUI will display some sort of indefinite waiting / refresh / loading indicator animation.
AlertView.Builder	setSoftButtons(List<SoftButtonObject> softButtons) Soft buttons the user may select to perform actions.
AlertView.Builder	setTertiaryText(String tertiaryText) The tertiary line of text for display on the alert.
AlertView.Builder	setText(String text) The primary line of text for display on the alert.
AlertView.Builder	setTimeout(Integer timeout) Timeout in seconds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setText

public AlertView.Builder setText(String text)

The primary line of text for display on the alert. If fewer than three alert lines are available on the head unit, the screen manager will automatically concatenate some of the lines together.

setSecondaryText

public AlertView.Builder setSecondaryText(String secondaryText)

The secondary line of text for display on the alert. If fewer than three alert lines are available on the head unit, the screen manager will automatically concatenate some of the lines together.

setTertiaryText

public AlertView.Builder setTertiaryText(String tertiaryText)

The tertiary line of text for display on the alert. If fewer than three alert lines are available on the head unit, the screen manager will automatically concatenate some of the lines together.

setTimeout

public AlertView.Builder setTimeout(Integer timeout)

Timeout in seconds. Defaults to 0, which will use `defaultTimeout`. If this is set below the minimum, it will be capped at 3 seconds. Minimum 3 seconds, maximum 10 seconds. If this is set above the maximum, it will be capped at 10 seconds. Defaults to 0. Please note that if a button is added to the alert, the defaultTimeout and timeout values will be ignored.

setShowWaitIndicator

public AlertView.Builder setShowWaitIndicator(boolean showWaitIndicator)

If supported, the alert GUI will display some sort of indefinite waiting / refresh / loading indicator animation. Defaults to NO.

setSoftButtons

public AlertView.Builder setSoftButtons(List<SoftButtonObject> softButtons)

Soft buttons the user may select to perform actions. Only one `SoftButtonState` per object is supported; if any soft button object contains multiple states, an exception will be thrown.

setAudio

public AlertView.Builder setAudio(AlertAudioData audio)

Text spoken, file(s) played, and/or tone played when the alert appears

setIcon

public AlertView.Builder setIcon(SdlArtwork icon)

An artwork that will be displayed when the icon appears. This will be uploaded prior to the appearance of the alert if necessary. This will not be uploaded if the head unit does not declare support for alertIcon.

setDefaultTimeOut

public AlertView.Builder setDefaultTimeOut(int defaultTimeOut)

Set this to change the default timeout for all alerts. If a timeout is not set on an individual alert object (or if it is set to 0.0), then it will use this timeout instead. See `timeout` for more details. If this is not set by you, it will default to 5 seconds. The minimum is 3 seconds, the maximum is 10 seconds. If this is set below the minimum, it will be capped at 3 seconds. If this is set above the maximum, it will be capped at 10 seconds.

build

public AlertView build()