com.smartdevicelink.proxy.rpc

Class UpdateTurnList

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.UpdateTurnList

All Implemented Interfaces:

Cloneable

public class UpdateTurnList
extends RPCRequest

Updates the list of next maneuvers, which can be requested by the user pressing the soft button "Turns" on the Navigation base screen. Three soft buttons are predefined by the system: Up, Down, Close

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_TURN_LIST

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
UpdateTurnList() Constructs a new UpdateTurnList object
UpdateTurnList(Hashtable<String,Object> hash) Constructs a new UpdateTurnList object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
List<SoftButton>	getSoftButtons() Gets the SoftButton List object
List<Turn>	getTurnList() Gets a list of turns to be shown to the user
UpdateTurnList	setSoftButtons(List<SoftButton> softButtons) Sets the SoftButtons
UpdateTurnList	setTurnList(List<Turn> turnList) Sets a list of turns to be shown 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_TURN_LIST

public static final String KEY_TURN_LIST

See Also:

Constant Field Values

KEY_SOFT_BUTTONS

public static final String KEY_SOFT_BUTTONS

See Also:

Constant Field Values

Constructor Detail

UpdateTurnList

public UpdateTurnList()

Constructs a new UpdateTurnList object

UpdateTurnList

public UpdateTurnList(Hashtable<String,Object> hash)

Constructs a new UpdateTurnList object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

Method Detail

setTurnList

public UpdateTurnList setTurnList(List<Turn> turnList)

Sets a list of turns to be shown to the user

Parameters:

turnList - a List value representing a list of turns to be shown to the user

Notes: Minsize=1; Maxsize=100

getTurnList

public List<Turn> getTurnList()

Gets a list of turns to be shown to the user

Returns:

List -a List value representing a list of turns

getSoftButtons

public List<SoftButton> getSoftButtons()

Gets the SoftButton List object

Returns:

List -a List representing the List object

Since:

SmartDeviceLink 2.0

setSoftButtons

public UpdateTurnList 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: 1

Since:

SmartDeviceLink 2.0