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

Class RPCStruct

Hierarchy

java.lang.Object

Package
com.smartdevicelink.proxy
All Known Subclasses
com.smartdevicelink.proxy.rpc.AddCommand, com.smartdevicelink.proxy.rpc.AddCommandResponse, com.smartdevicelink.proxy.rpc.AddSubMenu, com.smartdevicelink.proxy.rpc.AddSubMenuResponse, com.smartdevicelink.proxy.rpc.AirbagStatus, com.smartdevicelink.proxy.rpc.Alert, com.smartdevicelink.proxy.rpc.AlertManeuver, com.smartdevicelink.proxy.rpc.AlertManeuverResponse, com.smartdevicelink.proxy.rpc.AlertResponse, com.smartdevicelink.proxy.rpc.AudioControlCapabilities, com.smartdevicelink.proxy.rpc.AudioControlData, com.smartdevicelink.proxy.rpc.AudioPassThruCapabilities, com.smartdevicelink.proxy.rpc.BeltStatus, com.smartdevicelink.proxy.rpc.BodyInformation, com.smartdevicelink.proxy.rpc.ButtonCapabilities, com.smartdevicelink.proxy.rpc.ButtonPress, com.smartdevicelink.proxy.rpc.ButtonPressResponse, com.smartdevicelink.proxy.rpc.ChangeRegistration, com.smartdevicelink.proxy.rpc.ChangeRegistrationResponse, com.smartdevicelink.proxy.rpc.Choice, com.smartdevicelink.proxy.rpc.ClimateControlCapabilities, com.smartdevicelink.proxy.rpc.ClimateControlData, com.smartdevicelink.proxy.rpc.ClusterModeStatus, com.smartdevicelink.proxy.rpc.Coordinate, com.smartdevicelink.proxy.rpc.CreateInteractionChoiceSet, com.smartdevicelink.proxy.rpc.CreateInteractionChoiceSetResponse, com.smartdevicelink.proxy.rpc.DateTime, com.smartdevicelink.proxy.rpc.DeleteCommand, com.smartdevicelink.proxy.rpc.DeleteCommandResponse, com.smartdevicelink.proxy.rpc.DeleteFile, com.smartdevicelink.proxy.rpc.DeleteFileResponse, com.smartdevicelink.proxy.rpc.DeleteInteractionChoiceSet, com.smartdevicelink.proxy.rpc.DeleteInteractionChoiceSetResponse, com.smartdevicelink.proxy.rpc.DeleteSubMenu, com.smartdevicelink.proxy.rpc.DeleteSubMenuResponse, com.smartdevicelink.proxy.rpc.DeviceInfo, com.smartdevicelink.proxy.rpc.DeviceStatus, com.smartdevicelink.proxy.rpc.DiagnosticMessage, com.smartdevicelink.proxy.rpc.DiagnosticMessageResponse, com.smartdevicelink.proxy.rpc.DialNumber, com.smartdevicelink.proxy.rpc.DialNumberResponse, com.smartdevicelink.proxy.rpc.DIDResult, com.smartdevicelink.proxy.rpc.DisplayCapabilities, com.smartdevicelink.proxy.rpc.DTC, com.smartdevicelink.proxy.rpc.ECallInfo, com.smartdevicelink.proxy.rpc.EmergencyEvent, com.smartdevicelink.proxy.rpc.EndAudioPassThru, com.smartdevicelink.proxy.rpc.EndAudioPassThruResponse, com.smartdevicelink.proxy.rpc.EqualizerSettings, com.smartdevicelink.proxy.rpc.FuelRange, com.smartdevicelink.proxy.rpc.GenericResponse, com.smartdevicelink.proxy.rpc.GetDTCs, com.smartdevicelink.proxy.rpc.GetDTCsResponse, com.smartdevicelink.proxy.rpc.GetInteriorVehicleData, com.smartdevicelink.proxy.rpc.GetInteriorVehicleDataResponse, com.smartdevicelink.proxy.rpc.GetSystemCapability, com.smartdevicelink.proxy.rpc.GetSystemCapabilityResponse, com.smartdevicelink.proxy.rpc.GetVehicleData, com.smartdevicelink.proxy.rpc.GetVehicleDataResponse, com.smartdevicelink.proxy.rpc.GetWayPoints, com.smartdevicelink.proxy.rpc.GetWayPointsResponse, com.smartdevicelink.proxy.rpc.GPSData, com.smartdevicelink.proxy.rpc.HapticRect, com.smartdevicelink.proxy.rpc.Headers, com.smartdevicelink.proxy.rpc.HeadLampStatus, com.smartdevicelink.proxy.rpc.HMICapabilities, com.smartdevicelink.proxy.rpc.HMIPermissions, com.smartdevicelink.proxy.rpc.HMISettingsControlCapabilities, com.smartdevicelink.proxy.rpc.HMISettingsControlData, com.smartdevicelink.proxy.rpc.Image, com.smartdevicelink.proxy.rpc.ImageField, com.smartdevicelink.proxy.rpc.ImageResolution, com.smartdevicelink.proxy.rpc.KeyboardProperties, com.smartdevicelink.proxy.rpc.LightCapabilities, com.smartdevicelink.proxy.rpc.LightControlCapabilities, com.smartdevicelink.proxy.rpc.LightControlData, com.smartdevicelink.proxy.rpc.LightState, com.smartdevicelink.proxy.rpc.ListFiles, com.smartdevicelink.proxy.rpc.ListFilesResponse, com.smartdevicelink.proxy.rpc.LocationDetails, com.smartdevicelink.proxy.rpc.MassageCushionFirmness, com.smartdevicelink.proxy.rpc.MassageModeData, com.smartdevicelink.proxy.rpc.MenuParams, com.smartdevicelink.proxy.rpc.MetadataTags, com.smartdevicelink.proxy.rpc.ModuleData, com.smartdevicelink.proxy.rpc.MyKey, com.smartdevicelink.proxy.rpc.NavigationCapability, com.smartdevicelink.proxy.rpc.OasisAddress, com.smartdevicelink.proxy.rpc.OnAppInterfaceUnregistered, com.smartdevicelink.proxy.rpc.OnAudioPassThru, com.smartdevicelink.proxy.rpc.OnButtonEvent, com.smartdevicelink.proxy.rpc.OnButtonPress, com.smartdevicelink.proxy.rpc.OnCommand, com.smartdevicelink.proxy.rpc.OnDriverDistraction, com.smartdevicelink.proxy.rpc.OnHashChange, com.smartdevicelink.proxy.rpc.OnHMIStatus, com.smartdevicelink.proxy.rpc.OnInteriorVehicleData, com.smartdevicelink.proxy.rpc.OnKeyboardInput, com.smartdevicelink.proxy.rpc.OnLanguageChange, com.smartdevicelink.proxy.rpc.OnLockScreenStatus, com.smartdevicelink.proxy.rpc.OnPermissionsChange, com.smartdevicelink.proxy.rpc.OnRCStatus, com.smartdevicelink.proxy.rpc.OnSdlChoiceChosen, com.smartdevicelink.proxy.rpc.OnStreamRPC, com.smartdevicelink.proxy.rpc.OnSystemRequest, com.smartdevicelink.proxy.rpc.OnTBTClientState, com.smartdevicelink.proxy.rpc.OnTouchEvent, com.smartdevicelink.proxy.rpc.OnVehicleData, com.smartdevicelink.proxy.rpc.OnWayPointChange, com.smartdevicelink.proxy.rpc.ParameterPermissions, com.smartdevicelink.proxy.rpc.PerformAudioPassThru, com.smartdevicelink.proxy.rpc.PerformAudioPassThruResponse, com.smartdevicelink.proxy.rpc.PerformInteraction, com.smartdevicelink.proxy.rpc.PerformInteractionResponse, com.smartdevicelink.proxy.rpc.PermissionItem, com.smartdevicelink.proxy.rpc.PhoneCapability, com.smartdevicelink.proxy.rpc.PresetBankCapabilities, com.smartdevicelink.proxy.rpc.PutFile, com.smartdevicelink.proxy.rpc.PutFileResponse, com.smartdevicelink.proxy.rpc.RadioControlCapabilities, com.smartdevicelink.proxy.rpc.RadioControlData, com.smartdevicelink.proxy.rpc.RdsData, com.smartdevicelink.proxy.rpc.ReadDID, com.smartdevicelink.proxy.rpc.ReadDIDResponse, com.smartdevicelink.proxy.rpc.Rectangle, com.smartdevicelink.proxy.rpc.RegisterAppInterface, com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse, com.smartdevicelink.proxy.rpc.RemoteControlCapabilities, com.smartdevicelink.proxy.rpc.ResetGlobalProperties, com.smartdevicelink.proxy.rpc.ResetGlobalPropertiesResponse, com.smartdevicelink.proxy.rpc.RGBColor, com.smartdevicelink.proxy.RPCMessage, com.smartdevicelink.proxy.RPCNotification, com.smartdevicelink.proxy.RPCRequest, com.smartdevicelink.proxy.RPCResponse, com.smartdevicelink.proxy.rpc.ScreenParams, com.smartdevicelink.proxy.rpc.ScrollableMessage, com.smartdevicelink.proxy.rpc.ScrollableMessageResponse, com.smartdevicelink.proxy.rpc.SdlMsgVersion, com.smartdevicelink.proxy.rpc.SeatControlCapabilities, com.smartdevicelink.proxy.rpc.SeatControlData, com.smartdevicelink.proxy.rpc.SeatMemoryAction, com.smartdevicelink.proxy.rpc.SendHapticData, com.smartdevicelink.proxy.rpc.SendHapticDataResponse, com.smartdevicelink.proxy.rpc.SendLocation, com.smartdevicelink.proxy.rpc.SendLocationResponse, com.smartdevicelink.proxy.rpc.SetAppIcon, com.smartdevicelink.proxy.rpc.SetAppIconResponse, com.smartdevicelink.proxy.rpc.SetDisplayLayout, com.smartdevicelink.proxy.rpc.SetDisplayLayoutResponse, com.smartdevicelink.proxy.rpc.SetGlobalProperties, com.smartdevicelink.proxy.rpc.SetGlobalPropertiesResponse, com.smartdevicelink.proxy.rpc.SetInteriorVehicleData, com.smartdevicelink.proxy.rpc.SetInteriorVehicleDataResponse, com.smartdevicelink.proxy.rpc.SetMediaClockTimer, com.smartdevicelink.proxy.rpc.SetMediaClockTimerResponse, com.smartdevicelink.proxy.rpc.Show, com.smartdevicelink.proxy.rpc.ShowConstantTbt, com.smartdevicelink.proxy.rpc.ShowConstantTbtResponse, com.smartdevicelink.proxy.rpc.ShowResponse, com.smartdevicelink.proxy.rpc.SingleTireStatus, com.smartdevicelink.proxy.rpc.SisData, com.smartdevicelink.proxy.rpc.Slider, com.smartdevicelink.proxy.rpc.SliderResponse, com.smartdevicelink.proxy.rpc.SoftButton, com.smartdevicelink.proxy.rpc.SoftButtonCapabilities, com.smartdevicelink.proxy.rpc.Speak, com.smartdevicelink.proxy.rpc.SpeakResponse, com.smartdevicelink.proxy.rpc.StartTime, com.smartdevicelink.proxy.rpc.StationIDNumber, com.smartdevicelink.proxy.rpc.StreamRPCResponse, com.smartdevicelink.proxy.rpc.SubscribeButton, com.smartdevicelink.proxy.rpc.SubscribeButtonResponse, com.smartdevicelink.proxy.rpc.SubscribeVehicleData, com.smartdevicelink.proxy.rpc.SubscribeVehicleDataResponse, com.smartdevicelink.proxy.rpc.SubscribeWayPoints, com.smartdevicelink.proxy.rpc.SubscribeWayPointsResponse, com.smartdevicelink.proxy.rpc.SystemCapability, com.smartdevicelink.proxy.rpc.SystemRequest, com.smartdevicelink.proxy.rpc.SystemRequestResponse, com.smartdevicelink.proxy.rpc.Temperature, com.smartdevicelink.proxy.rpc.TemplateColorScheme, com.smartdevicelink.proxy.rpc.TextField, com.smartdevicelink.proxy.rpc.TireStatus, com.smartdevicelink.proxy.rpc.TouchCoord, com.smartdevicelink.proxy.rpc.TouchEvent, com.smartdevicelink.proxy.rpc.TouchEventCapabilities, com.smartdevicelink.proxy.rpc.TTSChunk, com.smartdevicelink.proxy.rpc.Turn, com.smartdevicelink.proxy.rpc.UnregisterAppInterface, com.smartdevicelink.proxy.rpc.UnregisterAppInterfaceResponse, com.smartdevicelink.proxy.rpc.UnsubscribeButton, com.smartdevicelink.proxy.rpc.UnsubscribeButtonResponse, com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData, com.smartdevicelink.proxy.rpc.UnsubscribeVehicleDataResponse, com.smartdevicelink.proxy.rpc.UnsubscribeWayPoints, com.smartdevicelink.proxy.rpc.UnsubscribeWayPointsResponse, com.smartdevicelink.proxy.rpc.UpdateTurnList, com.smartdevicelink.proxy.rpc.UpdateTurnListResponse, com.smartdevicelink.proxy.rpc.VehicleDataResult, com.smartdevicelink.proxy.rpc.VehicleType, com.smartdevicelink.proxy.rpc.VideoStreamingCapability, com.smartdevicelink.proxy.rpc.VideoStreamingFormat, com.smartdevicelink.proxy.rpc.VrHelpItem

Fields

KEY_BULK_DATA

public static final java.lang.String KEY_BULK_DATA
Constant Value
"bulkData"

KEY_PROTECTED

public static final java.lang.String KEY_PROTECTED
Constant Value
"protected"

store

protected java.util.Hashtable store

Constructors

RPCStruct()

public RPCStruct()

RPCStruct( RPCStruct rpcs )

protected RPCStruct(RPCStruct rpcs)

Parameters

rpcs

RPCStruct( java.util.Hashtable<java.lang.String, java.lang.Object> hashtable )

public RPCStruct(java.util.Hashtable<java.lang.String, java.lang.Object> hashtable)

Parameters

hashtable

Methods

getStoreValue( String key )

public boolean getStoreValue(String key)

Parameters

key

getStore()

public java.util.Hashtable getStore()

deserializeJSON( JSONObject jsonObject )

public void deserializeJSON(JSONObject jsonObject) throws org.json.JSONException

Parameters

jsonObject

Throws

  • org.json.JSONException

deserializeJSONObject( JSONObject jsonObject )

Deprecated

public static java.util.Hashtable deserializeJSONObject(JSONObject jsonObject) throws org.json.JSONException

Parameters

jsonObject

Throws

  • org.json.JSONException

serializeJSON()

public org.json.JSONObject serializeJSON() throws org.json.JSONException

Throws

  • org.json.JSONException

serializeJSON( byte protocolVersion )

public org.json.JSONObject serializeJSON(byte protocolVersion) throws org.json.JSONException

Parameters

protocolVersion

Throws

  • org.json.JSONException

format( Version rpcVersion, boolean formatParams )

This method should clean the the RPC to make sure it is compliant with the spec.

NOTE: Super needs to be called at the END of the method

public void format(Version rpcVersion,boolean formatParams)

Parameters

rpcVersion
the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.
formatParams
if true, the format method will be called on subsequent params

getBulkData()

public byte getBulkData()

setBulkData( byte[] bulkData )

public void setBulkData(byte[] bulkData)

Parameters

bulkData

setPayloadProtected( Boolean bVal )

public void setPayloadProtected(Boolean bVal)

Parameters

bVal

isPayloadProtected()

public java.lang.Boolean isPayloadProtected()

getMessageTypeName( java.util.Set<java.lang.String> keys )

protected java.lang.String getMessageTypeName(java.util.Set<java.lang.String> keys)

Parameters

keys

hasKey( java.util.Set<java.lang.String> keys, String keyName )

protected boolean hasKey(java.util.Set<java.lang.String> keys,String keyName)

Parameters

keys
keyName

setValue( String key, Object value )

public void setValue(String key,Object value)

Parameters

key
value

getValue( String key )

public java.lang.Object getValue(String key)

Parameters

key

getObject( java.lang.Class tClass, String key )

public java.lang.Object getObject(java.lang.Class tClass,String key)

Parameters

tClass
key

formatObject( java.lang.Class tClass, Object obj )

protected java.lang.Object formatObject(java.lang.Class tClass,Object obj)

Parameters

tClass
a Class to cast Objects to
obj
Object returned from a stored hashtable

getValueForString( java.lang.Class tClass, String s )

protected java.lang.Object getValueForString(java.lang.Class tClass,String s)

Parameters

tClass
- a Class with a `valueForString(String s)` method that returns an Object for a given String
s
- a String to be converted to an Object using a `valueForString(String s)` method

getString( String key )

public java.lang.String getString(String key)

Parameters

key

getInteger( String key )

public java.lang.Integer getInteger(String key)

Parameters

key

getDouble( String key )

public java.lang.Double getDouble(String key)

Parameters

key

getFloat( String key )

public java.lang.Float getFloat(String key)

Parameters

key

getBoolean( String key )

public java.lang.Boolean getBoolean(String key)

Parameters

key

getLong( String key )

public java.lang.Long getLong(String key)

Parameters

key

Inherited Methods

From Class Methods
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section