Choice (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.rpc.Choice

All Implemented Interfaces:: Cloneable

public class Choice
extends RPCStruct

A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction. For example, the application may request for the user`s choice among several suggested ones: Yes, No, Skip.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
choiceID	Integer	Application-scoped identifier that uniquely identifies this choice. Min: 0; Max: 65535	SmartDeviceLink 1.0
menuName	String	Text which appears in menu, representing this choice. Min: 1; Max: 100	SmartDeviceLink 1.0
vrCommands	String[]	An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element	SmartDeviceLink 1.0
image	Image	Either a static hex icon value or a binary image file name identifier (sent by PutFile).	SmartDeviceLink 2.0

Since:: SmartDeviceLink 1.0
See Also:: AddCommand, PerformInteraction, Image

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_CHOICE_ID`
`static String`	`KEY_IMAGE`
`static String`	`KEY_MENU_NAME`
`static String`	`KEY_SECONDARY_IMAGE`
`static String`	`KEY_SECONDARY_TEXT`
`static String`	`KEY_TERTIARY_TEXT`
`static String`	`KEY_VR_COMMANDS`

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description
`Choice()` Constructs a newly allocated Choice object
`Choice(Hashtable<String,Object> hash)` Constructs a newly allocated Choice object indicated by the Hashtable parameter
`Choice(Integer choiceID, String menuName)` Constructs a newly allocated Choice object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`format(Version rpcVersion, boolean formatParams)` VrCommands became optional as of RPC Spec 5.0.
`Integer`	`getChoiceID()` Get the application-scoped identifier that uniquely identifies this choice.
`Image`	`getImage()` Get the image
`String`	`getMenuName()` Text which appears in menu, representing this choice.
`Image`	`getSecondaryImage()`
`String`	`getSecondaryText()`
`String`	`getTertiaryText()`
`List<String>`	`getVrCommands()` Get an array of strings to be used as VR synonyms for this choice.
`Choice`	`setChoiceID(Integer choiceID)` Set the application-scoped identifier that uniquely identifies this choice.
`Choice`	`setIgnoreAddingVRItems(boolean ignoreAddingVRItems)` This prevents the @{link Choice#format} method from adding VR commands if set to true
`Choice`	`setImage(Image image)` Set the image
`Choice`	`setMenuName(String menuName)` Text which appears in menu, representing this choice.
`Choice`	`setSecondaryImage(Image image)`
`Choice`	`setSecondaryText(String secondaryText)`
`Choice`	`setTertiaryText(String tertiaryText)`
`Choice`	`setVrCommands(List<String> vrCommands)` Set an array of strings to be used as VR synonyms for this choice.

Methods inherited from class com.smartdevicelink.proxy.RPCStruct
clone, deserializeJSON, equals, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, 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_SECONDARY_TEXT
```
public static final String KEY_SECONDARY_TEXT
```
    See Also:
    
    Constant Field Values
  - KEY_TERTIARY_TEXT
```
public static final String KEY_TERTIARY_TEXT
```
    See Also:
    
    Constant Field Values
  - KEY_SECONDARY_IMAGE
```
public static final String KEY_SECONDARY_IMAGE
```
    See Also:
    
    Constant Field Values
  - KEY_MENU_NAME
```
public static final String KEY_MENU_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_VR_COMMANDS
```
public static final String KEY_VR_COMMANDS
```
    See Also:
    
    Constant Field Values
  - KEY_CHOICE_ID
```
public static final String KEY_CHOICE_ID
```
    See Also:
    
    Constant Field Values
  - KEY_IMAGE
```
public static final String KEY_IMAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Choice
```
public Choice()
```
    Constructs a newly allocated Choice object
  - Choice
```
public Choice(Hashtable<String,Object> hash)
```
    Constructs a newly allocated Choice object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
  - Choice
```
public Choice(@NonNull
              Integer choiceID,
              @NonNull
              String menuName)
```
    Constructs a newly allocated Choice object
    
    Parameters:
    
    choiceID - Min: 0 Max: 65535
    
    menuName - the menu name
- Method Detail
  - format
```
public void format(Version rpcVersion,
                   boolean formatParams)
```
    VrCommands became optional as of RPC Spec 5.0. On legacy systems, we must still set VrCommands, as they are expected, even though the developer may not specify them.
    
    Additionally, VrCommands must be unique, therefore we will use the string value of the command's ID
    
    Overrides:
    
    format in class RPCStruct
    
    Parameters:
    
    rpcVersion - the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.
    
    formatParams - if true, the format method will be called on subsequent params
  - getChoiceID
```
public Integer getChoiceID()
```
    Get the application-scoped identifier that uniquely identifies this choice.
    
    Returns:
    
    choiceID Min: 0; Max: 65535
  - setChoiceID
```
public Choice setChoiceID(@NonNull
                          Integer choiceID)
```
    Set the application-scoped identifier that uniquely identifies this choice.
    
    Parameters:
    
    choiceID - Min: 0 Max: 65535
  - getMenuName
```
public String getMenuName()
```
    Text which appears in menu, representing this choice. Min: 1; Max: 100
    
    Returns:
    
    menuName the menu name
  - setMenuName
```
public Choice setMenuName(@NonNull
                          String menuName)
```
    Text which appears in menu, representing this choice. Min: 1; Max: 100
    
    Parameters:
    
    menuName - the menu name
  - getVrCommands
```
public List<String> getVrCommands()
```
    Get an array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element
    
    Returns:
    
    vrCommands List
    
    Since:
    
    SmartDeviceLink 2.0
  - setVrCommands
```
public Choice setVrCommands(List<String> vrCommands)
```
    Set an array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element
    
    Parameters:
    
    vrCommands - the List of vrCommands
    
    Since:
    
    SmartDeviceLink 2.0
  - setImage
```
public Choice setImage(Image image)
```
    Set the image
    
    Parameters:
    
    image - the image of the choice
  - getImage
```
public Image getImage()
```
    Get the image
    
    Returns:
    
    the image of the choice
  - getSecondaryText
```
public String getSecondaryText()
```
  - setSecondaryText
```
public Choice setSecondaryText(String secondaryText)
```
  - getTertiaryText
```
public String getTertiaryText()
```
  - setTertiaryText
```
public Choice setTertiaryText(String tertiaryText)
```
  - setSecondaryImage
```
public Choice setSecondaryImage(Image image)
```
  - getSecondaryImage
```
public Image getSecondaryImage()
```
  - setIgnoreAddingVRItems
```
public Choice setIgnoreAddingVRItems(boolean ignoreAddingVRItems)
```
    This prevents the @{link Choice#format} method from adding VR commands if set to true
    
    Parameters:
    
    ignoreAddingVRItems - - whether or not to let the format method add vr commands

Class Choice

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_SECONDARY_TEXT

KEY_TERTIARY_TEXT

KEY_SECONDARY_IMAGE

KEY_MENU_NAME

KEY_VR_COMMANDS

KEY_CHOICE_ID

KEY_IMAGE

Constructor Detail

Choice

Choice

Choice

Method Detail

format

getChoiceID

setChoiceID

getMenuName

setMenuName

getVrCommands

setVrCommands

setImage

getImage

getSecondaryText

setSecondaryText

getTertiaryText

setTertiaryText

setSecondaryImage

getSecondaryImage

setIgnoreAddingVRItems