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

Class OnSystemRequest

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud. Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)

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

Fields

KEY_URL_V1

public static final java.lang.String KEY_URL_V1
Constant Value
"URL"

KEY_URL

public static final java.lang.String KEY_URL
Constant Value
"url"

KEY_TIMEOUT_V1

public static final java.lang.String KEY_TIMEOUT_V1
Constant Value
"Timeout"

KEY_TIMEOUT

public static final java.lang.String KEY_TIMEOUT
Constant Value
"timeout"

KEY_HEADERS

public static final java.lang.String KEY_HEADERS
Constant Value
"headers"

KEY_BODY

public static final java.lang.String KEY_BODY
Constant Value
"body"

KEY_FILE_TYPE

public static final java.lang.String KEY_FILE_TYPE
Constant Value
"fileType"

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"

KEY_OFFSET

public static final java.lang.String KEY_OFFSET
Constant Value
"offset"

KEY_LENGTH

public static final java.lang.String KEY_LENGTH
Constant Value
"length"

Inherited Fields

From Class Fields
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

OnSystemRequest()

Constructs a new OnSystemsRequest object

public OnSystemRequest()

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

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

Parameters

hash

OnSystemRequest( java.util.Hashtable<java.lang.String, java.lang.Object> hash, byte[] bulkData )

public OnSystemRequest(java.util.Hashtable<java.lang.String, java.lang.Object> hash,byte[] bulkData)

Parameters

hash
bulkData

OnSystemRequest( RequestType requestType )

Constructs a new OnSystemsRequest object

public OnSystemRequest(RequestType requestType)

Parameters

requestType

Methods

setBinData( byte[] aptData )

Deprecated

public void setBinData(byte[] aptData)

Parameters

aptData

getBinData()

Deprecated

public byte getBinData()

setBulkData( byte[] bulkData )

public void setBulkData(byte[] bulkData)

Parameters

bulkData

getLegacyData()

public java.util.List getLegacyData()

getBody()

public java.lang.String getBody()

setBody( String body )

public void setBody(String body)

Parameters

body

setHeaders( Headers header )

public void setHeaders(Headers header)

Parameters

header

getHeader()

public com.smartdevicelink.proxy.rpc.Headers getHeader()

getRequestType()

public com.smartdevicelink.proxy.rpc.enums.RequestType getRequestType()

setRequestType( RequestType requestType )

public void setRequestType(RequestType requestType)

Parameters

requestType

getRequestSubType()

public java.lang.String getRequestSubType()

setRequestSubType( String requestSubType )

public void setRequestSubType(String requestSubType)

Parameters

requestSubType

getUrl()

public java.lang.String getUrl()

setUrl( String url )

public void setUrl(String url)

Parameters

url

getFileType()

public com.smartdevicelink.proxy.rpc.enums.FileType getFileType()

setFileType( FileType fileType )

public void setFileType(FileType fileType)

Parameters

fileType

setOffset( Integer offset )

Deprecated

public void setOffset(Integer offset)

Parameters

offset

getOffset()

public java.lang.Long getOffset()

setOffset( Long offset )

public void setOffset(Long offset)

Parameters

offset

getTimeout()

public java.lang.Integer getTimeout()

setTimeout( Integer timeout )

public void setTimeout(Integer timeout)

Parameters

timeout

getLength()

public java.lang.Long getLength()

setLength( Integer length )

Deprecated

public void setLength(Integer length)

Parameters

length

setLength( Long length )

public void setLength(Long length)

Parameters

length

Inherited Methods

From Class Methods
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