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

Class GenericResponse

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

Generic Response is sent, when the name of a received msg cannot be retrieved. Only used in case of an error. Currently, only resultCode INVALID_DATA is used.

Parameter List

Param Name Type Description Req. Notes Version Available
success Boolean true, if successful; false, if failed SmartDeviceLink 1.0
resultCode Result Defines the possible result codes returned by SDL to the application in a Response to a requested operation SmartDeviceLink 1.0
info String Provides additional human readable info regarding the result. N maxlength=1000 SmartDeviceLink 1.0

Fields

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

GenericResponse()

public GenericResponse()

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

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

Parameters

hash

GenericResponse( Boolean success, Result resultCode )

Constructs a new GenericResponse object

public GenericResponse(Boolean success,Result resultCode)

Parameters

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

Methods

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCResponse getCorrelationID, setCorrelationID, getSuccess, setSuccess, getResultCode, setResultCode, getInfo, setInfo
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