Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
PerformInteractionResponse

Class PerformInteractionResponse

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

PerformInteraction Response is sent, when PerformInteraction has been called

Fields

KEY_MANUAL_TEXT_ENTRY

public static final java.lang.String KEY_MANUAL_TEXT_ENTRY
Constant Value
"manualTextEntry"

KEY_TRIGGER_SOURCE

public static final java.lang.String KEY_TRIGGER_SOURCE
Constant Value
"triggerSource"

KEY_CHOICE_ID

public static final java.lang.String KEY_CHOICE_ID
Constant Value
"choiceID"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCResponse KEY_SUCCESS, KEY_INFO, KEY_RESULT_CODE
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

PerformInteractionResponse()

Constructs a new PerformInteractionResponse object

public PerformInteractionResponse()

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

Constructs a new PerformInteractionResponse object indicated by the Hashtable parameter

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

Constructor Parameters

hash
The Hashtable to use

PerformInteractionResponse( Boolean success, Result resultCode )

Constructs a new PerformInteractionResponse object

public PerformInteractionResponse(Boolean success,Result resultCode)

Constructor Parameters

success
whether the request is successfully processed
resultCode
whether the request is successfully processed

Methods

getChoiceID()

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

public java.lang.Integer getChoiceID()

setChoiceID( Integer choiceID )

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

public com.smartdevicelink.proxy.rpc.PerformInteractionResponse setChoiceID(Integer choiceID)

Method Parameters

choiceID
Min: 0 Max: 65535

getTriggerSource()

Returns a TriggerSource object which will be shown in the HMI

public com.smartdevicelink.proxy.rpc.enums.TriggerSource getTriggerSource()

setTriggerSource( TriggerSource triggerSource )

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

public com.smartdevicelink.proxy.rpc.PerformInteractionResponse setTriggerSource(TriggerSource triggerSource)

Method Parameters

triggerSource
a TriggerSource object

setManualTextEntry( String manualTextEntry )

public com.smartdevicelink.proxy.rpc.PerformInteractionResponse setManualTextEntry(String manualTextEntry)

Method Parameters

manualTextEntry

getManualTextEntry()

public java.lang.String getManualTextEntry()

Inherited Methods

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