com.smartdevicelink.proxy.rpc

Class PerformInteractionResponse

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCResponse

com.smartdevicelink.proxy.rpc.PerformInteractionResponse

All Implemented Interfaces:

Cloneable

public class PerformInteractionResponse
extends RPCResponse

PerformInteraction Response is sent, when PerformInteraction has been called

Since:

SmartDeviceLink 1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CHOICE_ID
static String	KEY_MANUAL_TEXT_ENTRY
static String	KEY_TRIGGER_SOURCE

Fields inherited from class com.smartdevicelink.proxy.RPCResponse

KEY_INFO, KEY_RESULT_CODE, KEY_SUCCESS

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
PerformInteractionResponse() Constructs a new PerformInteractionResponse object
PerformInteractionResponse(Boolean success, Result resultCode) Constructs a new PerformInteractionResponse object
PerformInteractionResponse(Hashtable<String,Object> hash) Constructs a new PerformInteractionResponse object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
Integer	getChoiceID() Gets the application-scoped identifier that uniquely identifies this choice.
String	getManualTextEntry()
TriggerSource	getTriggerSource() Returns a TriggerSource object which will be shown in the HMI
PerformInteractionResponse	setChoiceID(Integer choiceID) Sets the application-scoped identifier that uniquely identifies this choice.
PerformInteractionResponse	setManualTextEntry(String manualTextEntry)
PerformInteractionResponse	setTriggerSource(TriggerSource triggerSource) Sets TriggerSource Indicates whether command was selected via VR or via a menu selection (using the OK button).

Methods inherited from class com.smartdevicelink.proxy.RPCResponse

getCorrelationID, getInfo, getResultCode, getSuccess, setCorrelationID, setInfo, setResultCode, setSuccess

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_MANUAL_TEXT_ENTRY

public static final String KEY_MANUAL_TEXT_ENTRY

See Also:

Constant Field Values

KEY_TRIGGER_SOURCE

public static final String KEY_TRIGGER_SOURCE

See Also:

Constant Field Values

KEY_CHOICE_ID

public static final String KEY_CHOICE_ID

See Also:

Constant Field Values

Constructor Detail

PerformInteractionResponse

public PerformInteractionResponse()

Constructs a new PerformInteractionResponse object

PerformInteractionResponse

public PerformInteractionResponse(Hashtable<String,Object> hash)

Constructs a new PerformInteractionResponse object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

PerformInteractionResponse

public PerformInteractionResponse(@NonNull
                                  Boolean success,
                                  @NonNull
                                  Result resultCode)

Constructs a new PerformInteractionResponse object

Parameters:

success - whether the request is successfully processed

resultCode - whether the request is successfully processed

Method Detail

getChoiceID

public Integer getChoiceID()

Gets the application-scoped identifier that uniquely identifies this choice.

Returns:

choiceID Min: 0 Max: 65535

setChoiceID

public PerformInteractionResponse setChoiceID(Integer choiceID)

Sets the application-scoped identifier that uniquely identifies this choice.

Parameters:

choiceID - Min: 0 Max: 65535

getTriggerSource

public TriggerSource getTriggerSource()

Returns a TriggerSource object which will be shown in the HMI

Returns:

TriggerSource a TriggerSource object

setTriggerSource

public PerformInteractionResponse setTriggerSource(TriggerSource triggerSource)

Sets TriggerSource Indicates whether command was selected via VR or via a menu selection (using the OK button).

Parameters:

triggerSource - a TriggerSource object

setManualTextEntry

public PerformInteractionResponse setManualTextEntry(String manualTextEntry)

getManualTextEntry

public String getManualTextEntry()