Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class DeleteInteractionChoiceSet

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCRequest

Package
com.smartdevicelink.proxy.rpc

Overview

Deletes an existing Choice Set identified by the parameter interactionChoiceSetID. If the specified interactionChoiceSetID is currently in use by an active PerformInteraction this call to delete the Choice Set will fail returning an IN_USE resultCode

Function Group: Base

HMILevel needs to be FULL, LIMITED or BACKGROUD

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

Fields

KEY_INTERACTION_CHOICE_SET_ID

public static final java.lang.String KEY_INTERACTION_CHOICE_SET_ID
Constant Value
"interactionChoiceSetID"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

DeleteInteractionChoiceSet()

Constructs a new DeleteInteractionChoiceSet object

public DeleteInteractionChoiceSet()

DeleteInteractionChoiceSet( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new DeleteInteractionChoiceSet object indicated by the Hashtable parameter

public DeleteInteractionChoiceSet(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash
The Hashtable to use

DeleteInteractionChoiceSet( Integer interactionChoiceSetID )

Constructs a new DeleteInteractionChoiceSet object

public DeleteInteractionChoiceSet(Integer interactionChoiceSetID)

Parameters

interactionChoiceSetID
a unique ID that identifies the Choice Set

Notes: Min Value: 0; Max Value: 2000000000

Methods

getInteractionChoiceSetID()

Gets a unique ID that identifies the Choice Set

public java.lang.Integer getInteractionChoiceSetID()

setInteractionChoiceSetID( Integer interactionChoiceSetID )

Sets a unique ID that identifies the Choice Set

public void setInteractionChoiceSetID(Integer interactionChoiceSetID)

Parameters

interactionChoiceSetID
a unique ID that identifies the Choice Set

Notes: Min Value: 0; Max Value: 2000000000

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
com.smartdevicelink.proxy.RPCMessage getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section