com.smartdevicelink.proxy.rpc

Class SystemRequest

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.SystemRequest

All Implemented Interfaces:

Cloneable

public class SystemRequest
extends RPCRequest

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

Since:

SmartDeviceLink 3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DATA
static String	KEY_FILE_NAME
static String	KEY_REQUEST_SUB_TYPE
static String	KEY_REQUEST_TYPE

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

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
SystemRequest() Constructs a new SystemRequest object
SystemRequest(boolean bLegacy)
SystemRequest(Hashtable<String,Object> hash)
SystemRequest(RequestType requestType) Constructs a new SystemRequest object

Method Summary

Modifier and Type	Method and Description
String	getFileName()
List<String>	getLegacyData()
String	getRequestSubType()
RequestType	getRequestType()
SystemRequest	setFileName(String fileName)
SystemRequest	setLegacyData(List<String> data)
SystemRequest	setRequestSubType(String requestSubType)
SystemRequest	setRequestType(RequestType requestType)

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

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_FILE_NAME

public static final String KEY_FILE_NAME

See Also:

Constant Field Values

KEY_REQUEST_TYPE

public static final String KEY_REQUEST_TYPE

See Also:

Constant Field Values

KEY_REQUEST_SUB_TYPE

public static final String KEY_REQUEST_SUB_TYPE

See Also:

Constant Field Values

KEY_DATA

public static final String KEY_DATA

See Also:

Constant Field Values

Constructor Detail

SystemRequest

public SystemRequest()

Constructs a new SystemRequest object

SystemRequest

public SystemRequest(boolean bLegacy)

SystemRequest

public SystemRequest(Hashtable<String,Object> hash)

SystemRequest

public SystemRequest(@NonNull
                     RequestType requestType)

Constructs a new SystemRequest object

Parameters:

requestType - The type of system request.

Method Detail

getLegacyData

public List<String> getLegacyData()

setLegacyData

public SystemRequest setLegacyData(List<String> data)

getFileName

public String getFileName()

setFileName

public SystemRequest setFileName(String fileName)

getRequestType

public RequestType getRequestType()

setRequestType

public SystemRequest setRequestType(@NonNull
                                    RequestType requestType)

getRequestSubType

public String getRequestSubType()

setRequestSubType

public SystemRequest setRequestSubType(String requestSubType)