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

Class CreateInteractionChoiceSet

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

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

Fields

KEY_CHOICE_SET

public static final java.lang.String KEY_CHOICE_SET
Constant Value
"choiceSet"

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

CreateInteractionChoiceSet()

Constructs a new CreateInteractionChoiceSet object

public CreateInteractionChoiceSet()

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

Constructs a new CreateInteractionChoiceSet object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

CreateInteractionChoiceSet( Integer interactionChoiceSetID, java.util.List<com.smartdevicelink.proxy.rpc.Choice> choiceSet )

Constructs a new CreateInteractionChoiceSet object

public CreateInteractionChoiceSet(Integer interactionChoiceSetID,java.util.List<com.smartdevicelink.proxy.rpc.Choice> choiceSet)

Parameters

interactionChoiceSetID
choiceSet

Methods

getInteractionChoiceSetID()

Gets the Choice Set unique ID

public java.lang.Integer getInteractionChoiceSetID()

setInteractionChoiceSetID( Integer interactionChoiceSetID )

Sets a unique ID that identifies the Choice Set

public void setInteractionChoiceSetID(Integer interactionChoiceSetID)

Parameters

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

getChoiceSet()

Gets Choice Set Array of one or more elements

public java.util.List getChoiceSet()

setChoiceSet( java.util.List<com.smartdevicelink.proxy.rpc.Choice> choiceSet )

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

public void setChoiceSet(java.util.List<com.smartdevicelink.proxy.rpc.Choice> choiceSet)

Parameters

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

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