java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCNotification
Parameter List
| Name | Type | Description | Reg. | Notes | Version |
|---|---|---|---|---|---|
| requestType | RequestType | The type of system request. | Y | SmartDeviceLink 2.3.2 | |
| requestSubType | String | This parameter is filled for supporting OEM proprietary data exchanges. | N | Max Length: 255 | SmartDeviceLink 5.0 |
| url | Array of Strings | Optional URL for HTTP requests.If blank, the binary data shall be forwarded to the app.If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds. | N | maxlength: 1000; minsize:1; maxsize: 100 | SmartDeviceLink 2.3.2 |
| timeout | Integer | Optional timeout for HTTP requests;Required if a URL is provided | N | minvalue:0; maxvalue: 2000000000 | SmartDeviceLink |
| fileType | FileType | Optional file type (meant for HTTP file requests). | N | SmartDeviceLink 2.3.2 | |
| offset | Float | Optional offset in bytes for resuming partial data chunks | N | minvalue:0; maxvalue:100000000000 | SmartDeviceLink 2.3.2 |
| length | Float | Optional length in bytes for resuming partial data chunks | N | minvalue: 0; maxvalue:100000000000 | SmartDeviceLink 2.3.2 |
public static final java.lang.String KEY_URL_V1
public static final java.lang.String KEY_URL
public static final java.lang.String KEY_TIMEOUT_V1
public static final java.lang.String KEY_TIMEOUT
public static final java.lang.String KEY_HEADERS
public static final java.lang.String KEY_BODY
public static final java.lang.String KEY_FILE_TYPE
public static final java.lang.String KEY_REQUEST_TYPE
public static final java.lang.String KEY_REQUEST_SUB_TYPE
public static final java.lang.String KEY_DATA
public static final java.lang.String KEY_OFFSET
public static final java.lang.String KEY_LENGTH
Constructs a new OnSystemsRequest object
public OnSystemRequest()
public OnSystemRequest(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
public OnSystemRequest(java.util.Hashtable<java.lang.String, java.lang.Object> hash,byte[] bulkData)
Constructs a new OnSystemsRequest object
public OnSystemRequest(RequestType requestType)
Deprecated
public void setBinData(byte[] aptData)
Deprecated
public byte getBinData()
public void setBulkData(byte[] bulkData)
public java.util.List getLegacyData()
public java.lang.String getBody()
public void setBody(String body)
public void setHeaders(Headers header)
public com.smartdevicelink.proxy.rpc.Headers getHeader()
public com.smartdevicelink.proxy.rpc.enums.RequestType getRequestType()
public void setRequestType(RequestType requestType)
public java.lang.String getRequestSubType()
public void setRequestSubType(String requestSubType)
public java.lang.String getUrl()
public void setUrl(String url)
public com.smartdevicelink.proxy.rpc.enums.FileType getFileType()
public void setFileType(FileType fileType)
Deprecated
public void setOffset(Integer offset)
public java.lang.Long getOffset()
public void setOffset(Long offset)
public java.lang.Integer getTimeout()
public void setTimeout(Integer timeout)
public java.lang.Long getLength()
Deprecated
public void setLength(Integer length)
public void setLength(Long length)
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCMessage | getFunctionID, 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 |