com.smartdevicelink.proxy.rpc

Class AlertManeuver

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.AlertManeuver

All Implemented Interfaces:

Cloneable

public class AlertManeuver
extends RPCRequest

This will bring up an alert with information related to the next navigation maneuver including potential voice navigation instructions. Shown information will be taken from the ShowConstantTBT function

Function Group: Navigation

HMILevel needs to be FULL, LIMITED or BACKGROUND

Since:

SmartDeviceLink 2.0

See Also:

ShowConstantTbt

Field Summary

Fields

Modifier and Type	Field and Description
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
AlertManeuver() Constructs a new AlertManeuver object
AlertManeuver(Hashtable<String,Object> hash) Constructs a new AlertManeuver object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
List<SoftButton>	getSoftButtons() Gets the SoftButton List object
List<TTSChunk>	getTtsChunks() Gets TTSChunk[], the Array of type TTSChunk which, taken together, specify what is to be spoken to the user
AlertManeuver	setSoftButtons(List<SoftButton> softButtons) Sets the SoftButtons
AlertManeuver	setTtsChunks(List<TTSChunk> ttsChunks) Sets array of type TTSChunk which, taken together, specify what is to be spoken to the user

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_TTS_CHUNKS

public static final String KEY_TTS_CHUNKS

See Also:

Constant Field Values

KEY_SOFT_BUTTONS

public static final String KEY_SOFT_BUTTONS

See Also:

Constant Field Values

Constructor Detail

AlertManeuver

public AlertManeuver()

Constructs a new AlertManeuver object

AlertManeuver

public AlertManeuver(Hashtable<String,Object> hash)

Constructs a new AlertManeuver object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

Method Detail

getSoftButtons

public List<SoftButton> getSoftButtons()

Gets the SoftButton List object

Returns:

List -a List representing the List object

Since:

SmartDeviceLink 2.0

setSoftButtons

public AlertManeuver setSoftButtons(List<SoftButton> softButtons)

Sets the SoftButtons

Parameters:

softButtons - a List value

Notes:

• If omitted on supported displays, the alert will not have any SoftButton
• ArrayMin: 0
• ArrayMax: 4

Since:

SmartDeviceLink 2.0

getTtsChunks

public List<TTSChunk> getTtsChunks()

Gets TTSChunk[], the Array of type TTSChunk which, taken together, specify what is to be spoken to the user

Returns:

List -a List value specify what is to be spoken to the user

setTtsChunks

public AlertManeuver setTtsChunks(List<TTSChunk> ttsChunks)

Sets array of type TTSChunk which, taken together, specify what is to be spoken to the user

Parameters:

ttsChunks -

Notes:

Array must have a least one element