Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
JavaEE Documentation
AlertView.Builder

Class AlertView.Builder

Hierarchy

java.lang.Object

Package
com.smartdevicelink.managers.screen

Constructors

Builder()

public Builder()

Methods

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.

public com.smartdevicelink.managers.screen.AlertView.Builder setText(String text)

Parameters

text

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.

public com.smartdevicelink.managers.screen.AlertView.Builder setSecondaryText(String secondaryText)

Parameters

secondaryText

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.

public com.smartdevicelink.managers.screen.AlertView.Builder setTertiaryText(String tertiaryText)

Parameters

tertiaryText

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.

public com.smartdevicelink.managers.screen.AlertView.Builder setTimeout(Integer timeout)

Parameters

timeout

setShowWaitIndicator( boolean showWaitIndicator )

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

public com.smartdevicelink.managers.screen.AlertView.Builder setShowWaitIndicator(boolean showWaitIndicator)

Parameters

showWaitIndicator

setSoftButtons( java.util.List<com.smartdevicelink.managers.screen.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.

public com.smartdevicelink.managers.screen.AlertView.Builder setSoftButtons(java.util.List<com.smartdevicelink.managers.screen.SoftButtonObject> softButtons)

Parameters

softButtons

setAudio( AlertAudioData audio )

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

public com.smartdevicelink.managers.screen.AlertView.Builder setAudio(AlertAudioData audio)

Parameters

audio

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.

public com.smartdevicelink.managers.screen.AlertView.Builder setIcon(SdlArtwork icon)

Parameters

icon

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.

public com.smartdevicelink.managers.screen.AlertView.Builder setDefaultTimeOut(int defaultTimeOut)

Parameters

defaultTimeOut

build()

public com.smartdevicelink.managers.screen.AlertView build()

Inherited Methods

From Class Methods
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section