public class DeleteInteractionChoiceSet extends RPCRequest
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 (specified in a previous call to CreateInteractionChoiceSet) | Y | Min Value: 0 ; Max Value: 2000000000 | SmartDeviceLink 1.0 |
Response
If a resultCode of "SUCCESS" is returned, the requested choice set has been created and can now be referenced by the application using the value of interactionChoiceSetID provided by the application.
Non-default Result Codes:
SUCCESS
INVALID_DATA
OUT_OF_MEMORY
TOO_MANY_PENDING_REQUESTS
APPLICATION_NOT_REGISTERED
GENERIC_ERROR
REJECTED
INVALID_ID
CreateInteractionChoiceSet,
PerformInteraction| Modifier and Type | Field and Description |
|---|---|
static String |
KEY_INTERACTION_CHOICE_SET_ID |
onResponseListenerfunction, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parametersKEY_BULK_DATA, KEY_PROTECTED, store| Constructor and Description |
|---|
DeleteInteractionChoiceSet()
Constructs a new DeleteInteractionChoiceSet object
|
DeleteInteractionChoiceSet(Hashtable<String,Object> hash)
Constructs a new DeleteInteractionChoiceSet object indicated by the
Hashtable parameter
|
DeleteInteractionChoiceSet(Integer interactionChoiceSetID)
Constructs a new DeleteInteractionChoiceSet object
|
| Modifier and Type | Method and Description |
|---|---|
Integer |
getInteractionChoiceSetID()
Gets a unique ID that identifies the Choice Set
|
DeleteInteractionChoiceSet |
setInteractionChoiceSetID(Integer interactionChoiceSetID)
Sets a unique ID that identifies the Choice Set
|
getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListenergetBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParametersclone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValuepublic static final String KEY_INTERACTION_CHOICE_SET_ID
public DeleteInteractionChoiceSet()
public DeleteInteractionChoiceSet(Hashtable<String,Object> hash)
Constructs a new DeleteInteractionChoiceSet object indicated by the Hashtable parameter
hash - The Hashtable to usepublic DeleteInteractionChoiceSet(@NonNull
Integer interactionChoiceSetID)
interactionChoiceSetID - a unique ID that identifies the Choice Set
Notes: Min Value: 0; Max Value: 2000000000
public Integer getInteractionChoiceSetID()
public DeleteInteractionChoiceSet setInteractionChoiceSetID(@NonNull Integer interactionChoiceSetID)
interactionChoiceSetID - a unique ID that identifies the Choice Set
Notes: Min Value: 0; Max Value: 2000000000