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

Class PutFileResponse

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

Put File Response is sent, when PutFile has been called

Fields

KEY_SPACE_AVAILABLE

public static final java.lang.String KEY_SPACE_AVAILABLE
Constant Value
"spaceAvailable"

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

PutFileResponse()

Constructs a new PutFileResponse object

public PutFileResponse()

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

Constructs a new PutFileResponse object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

PutFileResponse( Boolean success, Result resultCode, Integer spaceAvailable )

public PutFileResponse(Boolean success,Result resultCode,Integer spaceAvailable)

Parameters

success
whether the request is successfully processed
resultCode
whether the request is successfully processed
spaceAvailable
the spaceAvailable on the head unit

PutFileResponse( Boolean success, Result resultCode )

Constructs a new PutFileResponse object

public PutFileResponse(Boolean success,Result resultCode)

Parameters

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

Methods

format( Version rpcVersion, boolean formatParams )

SpaceAvailable became optional as of RPC Spec 5.0. If a system that expected the value to always have a value connects to such a system, it could return null. Check to see if there is a value, and if not, set it to MAX_VALUE as defined by the RPC Spec

public void format(Version rpcVersion,boolean formatParams)

Parameters

rpcVersion
the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.
formatParams
if true, the format method will be called on subsequent params

setSpaceAvailable( Integer spaceAvailable )

public void setSpaceAvailable(Integer spaceAvailable)

Parameters

spaceAvailable

getSpaceAvailable()

public java.lang.Integer getSpaceAvailable()

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