com.smartdevicelink.proxy.rpc

Class CreateInteractionChoiceSet

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.CreateInteractionChoiceSet

All Implemented Interfaces:

Cloneable

public class CreateInteractionChoiceSet
extends RPCRequest

Creates a Choice Set which can be used in subsequent PerformInteraction Operations.

Function Group: Base

HMILevel needs to be FULL, LIMITED or BACKGROUND

AudioStreamingState : ANY

SystemContext: MAIN, MENU, VR

Parameter List

Name	Type	Description	Reg.	Notes	Version
interactionChoiceSetID	Integer	A unique ID that identifies the Choice Set	Y	Min Value: 0; Max Value: 2000000000	SmartDeviceLink 1.0
choiceSet	Choice[]	Array of one or more elements.	Y	Min Value: 1; Max Value: 100	SmartDeviceLink 1.0

Note:

Second Utterance issue with CreateInteractionChoiceSet RPC. Before a perform interaction is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC. If you do not wait the system may not recognize the first utterance from the user.

Response

Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the Choice Set was created.

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

INVALID_ID

DUPLICATE_NAME

UNSUPPORTED_RESOURCE

Since:

SmartDeviceLink 1.0

See Also:

DeleteInteractionChoiceSet, PerformInteraction

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CHOICE_SET
static String	KEY_INTERACTION_CHOICE_SET_ID

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
CreateInteractionChoiceSet() Constructs a new CreateInteractionChoiceSet object
CreateInteractionChoiceSet(Hashtable<String,Object> hash) Constructs a new CreateInteractionChoiceSet object indicated by the Hashtable parameter
CreateInteractionChoiceSet(Integer interactionChoiceSetID, List<Choice> choiceSet) Constructs a new CreateInteractionChoiceSet object

Method Summary

Modifier and Type	Method and Description
List<Choice>	getChoiceSet() Gets Choice Set Array of one or more elements
Integer	getInteractionChoiceSetID() Gets the Choice Set unique ID
CreateInteractionChoiceSet	setChoiceSet(List<Choice> choiceSet) Sets a Choice Set that is an Array of one or more elements
CreateInteractionChoiceSet	setInteractionChoiceSetID(Integer interactionChoiceSetID) Sets a unique ID that identifies the Choice Set

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_CHOICE_SET

public static final String KEY_CHOICE_SET

See Also:

Constant Field Values

KEY_INTERACTION_CHOICE_SET_ID

public static final String KEY_INTERACTION_CHOICE_SET_ID

See Also:

Constant Field Values

Constructor Detail

CreateInteractionChoiceSet

public CreateInteractionChoiceSet()

Constructs a new CreateInteractionChoiceSet object

CreateInteractionChoiceSet

public CreateInteractionChoiceSet(Hashtable<String,Object> hash)

Constructs a new CreateInteractionChoiceSet object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

CreateInteractionChoiceSet

public CreateInteractionChoiceSet(@NonNull
                                  Integer interactionChoiceSetID,
                                  @NonNull
                                  List<Choice> choiceSet)

Constructs a new CreateInteractionChoiceSet object

Parameters:

interactionChoiceSetID: - an Integer value representing the Choice Set ID Notes: Min Value: 0; Max Value: 2000000000

choiceSet: - a List representing the array of one or more elements Notes: Min Value: 1; Max Value: 100

Method Detail

getInteractionChoiceSetID

public Integer getInteractionChoiceSetID()

Gets the Choice Set unique ID

Returns:

Integer -an Integer representing the Choice Set ID

setInteractionChoiceSetID

public CreateInteractionChoiceSet setInteractionChoiceSetID(@NonNull
                                                            Integer interactionChoiceSetID)

Sets a unique ID that identifies the Choice Set

Parameters:

interactionChoiceSetID - an Integer value representing the Choice Set ID Notes: Min Value: 0; Max Value: 2000000000

getChoiceSet

public List<Choice> getChoiceSet()

Gets Choice Set Array of one or more elements

Returns:

List -a List representing the array of one or more elements

setChoiceSet

public CreateInteractionChoiceSet setChoiceSet(@NonNull
                                               List<Choice> choiceSet)

Sets a Choice Set that is an Array of one or more elements

Parameters:

choiceSet - a List representing the array of one or more elements Notes: Min Value: 1; Max Value: 100