com.smartdevicelink.proxy.rpc

Class SubtleAlert

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.SubtleAlert

All Implemented Interfaces:

Cloneable

public class SubtleAlert
extends RPCRequest

Shows an alert which typically consists of text-to-speech message and text on the display. At least either alertText1, alertText2 or ttsChunks need to be provided.

Parameter List

Param Name	Type	Description	Required	Notes	Version Available
alertText1	String	The first line of the alert text field	N	Max Value: 500
alertText2	String	The second line of the alert text field	N	Max Value: 500
alertIcon	Image	Image to be displayed for the corresponding alert. See Image. If omitted on supported displays, no (or the default if applicable) icon should be displayed.	N
ttsChunks	List	An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item.	N	Min Value: 1; Max Value: 100
duration	Integer	Timeout in milliseconds. Typical timeouts are 3-5 seconds. If omitted, timeout is set to5s.	N	Min Value: 3000; Max Value: 10000; Default Value: 5000
softButtons	List	App defined SoftButtons. If omitted on supported displays, the displayed alert shall not have any SoftButtons.	N	Min Value: 0; Max Value: 2
cancelID	Integer	An ID for this specific alert to allow cancellation through the `CancelInteraction` RPC.	N

Since:

SmartDeviceLink 7.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ALERT_ICON
static String	KEY_ALERT_TEXT_1
static String	KEY_ALERT_TEXT_2
static String	KEY_CANCEL_ID
static String	KEY_DURATION
static String	KEY_SOFT_BUTTONS
static String	KEY_TTS_CHUNKS

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
SubtleAlert() Constructs a new SubtleAlert object
SubtleAlert(Hashtable<String,Object> hash) Constructs a new SubtleAlert object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
Image	getAlertIcon() Gets the alertIcon.
String	getAlertText1() Gets the alertText1.
String	getAlertText2() Gets the alertText2.
Integer	getCancelID() Gets the cancelID.
Integer	getDuration() Gets the duration.
List<SoftButton>	getSoftButtons() Gets the softButtons.
List<TTSChunk>	getTtsChunks() Gets the ttsChunks.
SubtleAlert	setAlertIcon(Image alertIcon) Sets the alertIcon.
SubtleAlert	setAlertText1(String alertText1) Sets the alertText1.
SubtleAlert	setAlertText2(String alertText2) Sets the alertText2.
SubtleAlert	setCancelID(Integer cancelID) Sets the cancelID.
SubtleAlert	setDuration(Integer duration) Sets the duration.
SubtleAlert	setSoftButtons(List<SoftButton> softButtons) Sets the softButtons.
SubtleAlert	setTtsChunks(List<TTSChunk> ttsChunks) Sets the ttsChunks.

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_ALERT_TEXT_1

public static final String KEY_ALERT_TEXT_1

See Also:

Constant Field Values

KEY_ALERT_TEXT_2

public static final String KEY_ALERT_TEXT_2

See Also:

Constant Field Values

KEY_ALERT_ICON

public static final String KEY_ALERT_ICON

See Also:

Constant Field Values

KEY_TTS_CHUNKS

public static final String KEY_TTS_CHUNKS

See Also:

Constant Field Values

KEY_DURATION

public static final String KEY_DURATION

See Also:

Constant Field Values

KEY_SOFT_BUTTONS

public static final String KEY_SOFT_BUTTONS

See Also:

Constant Field Values

KEY_CANCEL_ID

public static final String KEY_CANCEL_ID

See Also:

Constant Field Values

Constructor Detail

SubtleAlert

public SubtleAlert()

Constructs a new SubtleAlert object

SubtleAlert

public SubtleAlert(Hashtable<String,Object> hash)

Constructs a new SubtleAlert object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

Method Detail

setAlertText1

public SubtleAlert setAlertText1(String alertText1)

Sets the alertText1.

Parameters:

alertText1 - The first line of the alert text field

getAlertText1

public String getAlertText1()

Gets the alertText1.

Returns:

String The first line of the alert text field

setAlertText2

public SubtleAlert setAlertText2(String alertText2)

Sets the alertText2.

Parameters:

alertText2 - The second line of the alert text field

getAlertText2

public String getAlertText2()

Gets the alertText2.

Returns:

String The second line of the alert text field

setAlertIcon

public SubtleAlert setAlertIcon(Image alertIcon)

Sets the alertIcon.

Parameters:

alertIcon - Image to be displayed for the corresponding alert. See Image. If omitted on supported displays, no (or the default if applicable) icon should be displayed.

getAlertIcon

public Image getAlertIcon()

Gets the alertIcon.

Returns:

Image Image to be displayed for the corresponding alert. See Image. If omitted on supported displays, no (or the default if applicable) icon should be displayed.

setTtsChunks

public SubtleAlert setTtsChunks(List<TTSChunk> ttsChunks)

Sets the ttsChunks.

Parameters:

ttsChunks - An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item.

getTtsChunks

public List<TTSChunk> getTtsChunks()

Gets the ttsChunks.

Returns:

List An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item.

setDuration

public SubtleAlert setDuration(Integer duration)

Sets the duration.

Parameters:

duration - Timeout in milliseconds. Typical timeouts are 3-5 seconds. If omitted, timeout is set to 5s.

getDuration

public Integer getDuration()

Gets the duration.

Returns:

Integer Timeout in milliseconds. Typical timeouts are 3-5 seconds. If omitted, timeout is set to 5s.

setSoftButtons

public SubtleAlert setSoftButtons(List<SoftButton> softButtons)

Sets the softButtons.

Parameters:

softButtons - App defined SoftButtons. If omitted on supported displays, the displayed alert shall not have any SoftButtons.

getSoftButtons

public List<SoftButton> getSoftButtons()

Gets the softButtons.

Returns:

List App defined SoftButtons. If omitted on supported displays, the displayed alert shall not have any SoftButtons.

setCancelID

public SubtleAlert setCancelID(Integer cancelID)

Sets the cancelID.

Parameters:

cancelID - An ID for this specific alert to allow cancellation through the `CancelInteraction` RPC.

getCancelID

public Integer getCancelID()

Gets the cancelID.

Returns:

Integer An ID for this specific alert to allow cancellation through the `CancelInteraction` RPC.