Class SystemRequest
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
- Package
- com.smartdevicelink.proxy.rpc
Overview
An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)Parameter List
| Name | Type | Description | Reg. | Notes | Version |
|---|---|---|---|---|---|
| requestType | RequestType | The type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system. | Y | SmartDeviceLink 3.0 | |
| requestSubType | String | This parameter is filled for supporting OEM proprietary data exchanges. | N | Max Length: 255 | SmartDeviceLink 5.0 |
| fileName | String | Filename of HTTP data to store in predefined system staging area. Mandatory if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. | N | Max Length: 255 | SmartDeviceLink 3.0 |
Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_FILE_NAME
public static final java.lang.String KEY_FILE_NAME
- Constant Value
- "fileName"
KEY_REQUEST_TYPE
public static final java.lang.String KEY_REQUEST_TYPE
- Constant Value
- "requestType"
KEY_REQUEST_SUB_TYPE
public static final java.lang.String KEY_REQUEST_SUB_TYPE
- Constant Value
- "requestSubType"
KEY_DATA
public static final java.lang.String KEY_DATA
- Constant Value
- "data"
Inherited Fields
Constructors
SystemRequest()
Constructs a new SystemRequest object
public SystemRequest()
SystemRequest( boolean bLegacy )
public SystemRequest(boolean bLegacy)
Constructor Parameters
- bLegacy
SystemRequest( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
public SystemRequest(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
SystemRequest( RequestType requestType )
Constructs a new SystemRequest object
public SystemRequest(RequestType requestType)
Constructor Parameters
- requestType
- The type of system request.
Methods
getLegacyData()
public java.util.List getLegacyData()
setLegacyData( java.util.List<java.lang.String> data )
public com.smartdevicelink.proxy.rpc.SystemRequest setLegacyData(java.util.List<java.lang.String> data)
Method Parameters
- data
getFileName()
public java.lang.String getFileName()
setFileName( String fileName )
public com.smartdevicelink.proxy.rpc.SystemRequest setFileName(String fileName)
Method Parameters
- fileName
getRequestType()
public com.smartdevicelink.proxy.rpc.enums.RequestType getRequestType()
setRequestType( RequestType requestType )
public com.smartdevicelink.proxy.rpc.SystemRequest setRequestType(RequestType requestType)
Method Parameters
- requestType
getRequestSubType()
public java.lang.String getRequestSubType()
setRequestSubType( String requestSubType )
public com.smartdevicelink.proxy.rpc.SystemRequest setRequestSubType(String requestSubType)
Method Parameters
- requestSubType
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCRequest | getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener |
| 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 |