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

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

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

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
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

SystemRequest()

Constructs a new SystemRequest object

public SystemRequest()

SystemRequest( boolean bLegacy )

public SystemRequest(boolean bLegacy)

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)

Parameters

hash

SystemRequest( RequestType requestType )

Constructs a new SystemRequest object

public SystemRequest(RequestType requestType)

Parameters

requestType
The type of system request.

Methods

getLegacyData()

public java.util.List getLegacyData()

setLegacyData( java.util.List<java.lang.String> data )

public void setLegacyData(java.util.List<java.lang.String> data)

Parameters

data

getFileName()

public java.lang.String getFileName()

setFileName( String fileName )

public void setFileName(String fileName)

Parameters

fileName

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

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
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