Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
RPCMessage

Class RPCMessage

Hierarchy

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

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.Alert, com.smartdevicelink.proxy.rpc.AlertManeuver, com.smartdevicelink.proxy.rpc.AlertManeuverResponse, com.smartdevicelink.proxy.rpc.AlertResponse, com.smartdevicelink.proxy.rpc.ButtonPress, com.smartdevicelink.proxy.rpc.ButtonPressResponse, com.smartdevicelink.proxy.rpc.CancelInteraction, com.smartdevicelink.proxy.rpc.CancelInteractionResponse, com.smartdevicelink.proxy.rpc.ChangeRegistration, com.smartdevicelink.proxy.rpc.ChangeRegistrationResponse, com.smartdevicelink.proxy.rpc.CloseApplication, com.smartdevicelink.proxy.rpc.CloseApplicationResponse, com.smartdevicelink.proxy.rpc.CreateInteractionChoiceSet, com.smartdevicelink.proxy.rpc.CreateInteractionChoiceSetResponse, com.smartdevicelink.proxy.rpc.CreateWindow, com.smartdevicelink.proxy.rpc.CreateWindowResponse, 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.DeleteWindow, com.smartdevicelink.proxy.rpc.DeleteWindowResponse, com.smartdevicelink.proxy.rpc.DiagnosticMessage, com.smartdevicelink.proxy.rpc.DiagnosticMessageResponse, com.smartdevicelink.proxy.rpc.DialNumber, com.smartdevicelink.proxy.rpc.DialNumberResponse, com.smartdevicelink.proxy.rpc.EndAudioPassThru, com.smartdevicelink.proxy.rpc.EndAudioPassThruResponse, com.smartdevicelink.proxy.rpc.GenericResponse, com.smartdevicelink.proxy.rpc.GetAppServiceData, com.smartdevicelink.proxy.rpc.GetAppServiceDataResponse, com.smartdevicelink.proxy.rpc.GetCloudAppProperties, com.smartdevicelink.proxy.rpc.GetCloudAppPropertiesResponse, com.smartdevicelink.proxy.rpc.GetDTCs, com.smartdevicelink.proxy.rpc.GetDTCsResponse, com.smartdevicelink.proxy.rpc.GetFile, com.smartdevicelink.proxy.rpc.GetFileResponse, com.smartdevicelink.proxy.rpc.GetInteriorVehicleData, com.smartdevicelink.proxy.rpc.GetInteriorVehicleDataConsent, com.smartdevicelink.proxy.rpc.GetInteriorVehicleDataConsentResponse, 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.ListFiles, com.smartdevicelink.proxy.rpc.ListFilesResponse, com.smartdevicelink.proxy.rpc.OnAppCapabilityUpdated, com.smartdevicelink.proxy.rpc.OnAppInterfaceUnregistered, com.smartdevicelink.proxy.rpc.OnAppServiceData, 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.OnPermissionsChange, com.smartdevicelink.proxy.rpc.OnRCStatus, com.smartdevicelink.proxy.rpc.OnSubtleAlertPressed, com.smartdevicelink.proxy.rpc.OnSystemCapabilityUpdated, com.smartdevicelink.proxy.rpc.OnSystemRequest, com.smartdevicelink.proxy.rpc.OnTBTClientState, com.smartdevicelink.proxy.rpc.OnTouchEvent, com.smartdevicelink.proxy.rpc.OnUpdateFile, com.smartdevicelink.proxy.rpc.OnUpdateSubMenu, com.smartdevicelink.proxy.rpc.OnVehicleData, com.smartdevicelink.proxy.rpc.OnWayPointChange, com.smartdevicelink.proxy.rpc.PerformAppServiceInteraction, com.smartdevicelink.proxy.rpc.PerformAppServiceInteractionResponse, com.smartdevicelink.proxy.rpc.PerformAudioPassThru, com.smartdevicelink.proxy.rpc.PerformAudioPassThruResponse, com.smartdevicelink.proxy.rpc.PerformInteraction, com.smartdevicelink.proxy.rpc.PerformInteractionResponse, com.smartdevicelink.proxy.rpc.PublishAppService, com.smartdevicelink.proxy.rpc.PublishAppServiceResponse, com.smartdevicelink.proxy.rpc.PutFile, com.smartdevicelink.proxy.rpc.PutFileResponse, com.smartdevicelink.proxy.rpc.ReadDID, com.smartdevicelink.proxy.rpc.ReadDIDResponse, com.smartdevicelink.proxy.rpc.RegisterAppInterface, com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse, com.smartdevicelink.proxy.rpc.ReleaseInteriorVehicleDataModule, com.smartdevicelink.proxy.rpc.ReleaseInteriorVehicleDataModuleResponse, com.smartdevicelink.proxy.rpc.ResetGlobalProperties, com.smartdevicelink.proxy.rpc.ResetGlobalPropertiesResponse, com.smartdevicelink.proxy.RPCNotification, com.smartdevicelink.proxy.RPCRequest, com.smartdevicelink.proxy.RPCResponse, com.smartdevicelink.proxy.rpc.ScrollableMessage, com.smartdevicelink.proxy.rpc.ScrollableMessageResponse, 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.SetCloudAppProperties, com.smartdevicelink.proxy.rpc.SetCloudAppPropertiesResponse, 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.ShowAppMenu, com.smartdevicelink.proxy.rpc.ShowAppMenuResponse, com.smartdevicelink.proxy.rpc.ShowConstantTbt, com.smartdevicelink.proxy.rpc.ShowConstantTbtResponse, com.smartdevicelink.proxy.rpc.ShowResponse, com.smartdevicelink.proxy.rpc.Slider, com.smartdevicelink.proxy.rpc.SliderResponse, com.smartdevicelink.proxy.rpc.Speak, com.smartdevicelink.proxy.rpc.SpeakResponse, 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.SubtleAlert, com.smartdevicelink.proxy.rpc.SubtleAlertResponse, com.smartdevicelink.proxy.rpc.SystemRequest, com.smartdevicelink.proxy.rpc.SystemRequestResponse, com.smartdevicelink.proxy.rpc.UnpublishAppService, com.smartdevicelink.proxy.rpc.UnpublishAppServiceResponse, 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

Quick Jump

Fields
Constructors
Methods

Fields

KEY_REQUEST

public static final java.lang.String KEY_REQUEST
Constant Value
"request"

KEY_RESPONSE

public static final java.lang.String KEY_RESPONSE
Constant Value
"response"

KEY_NOTIFICATION

public static final java.lang.String KEY_NOTIFICATION
Constant Value
"notification"

KEY_FUNCTION_NAME

public static final java.lang.String KEY_FUNCTION_NAME
Constant Value
"name"

KEY_PARAMETERS

public static final java.lang.String KEY_PARAMETERS
Constant Value
"parameters"

KEY_CORRELATION_ID

public static final java.lang.String KEY_CORRELATION_ID
Constant Value
"correlationID"

messageType

protected java.lang.String messageType

parameters

protected java.util.Hashtable parameters

function

protected final java.util.Hashtable function

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

RPCMessage( String functionName )

public RPCMessage(String functionName)

Constructor Parameters

functionName

RPCMessage( RPCMessage rpcMessage )

protected RPCMessage(RPCMessage rpcMessage)

Constructor Parameters

rpcMessage

RPCMessage( RPCStruct rpcs )

protected RPCMessage(RPCStruct rpcs)

Constructor Parameters

rpcs

RPCMessage( String functionName, String messageType )

public RPCMessage(String functionName,String messageType)

Constructor Parameters

functionName
messageType

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

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

Constructor Parameters

hash

Methods

getFunctionID()

public com.smartdevicelink.protocol.enums.FunctionID getFunctionID()

getFunctionName()

public java.lang.String getFunctionName()

setFunctionName( String functionName )

protected com.smartdevicelink.proxy.RPCMessage setFunctionName(String functionName)

Method Parameters

functionName

getMessageType()

public java.lang.String getMessageType()

setParameters( String key, Object value )

public com.smartdevicelink.proxy.RPCMessage setParameters(String key,Object value)

Method Parameters

key
value

getParameters( String key )

public java.lang.Object getParameters(String key)

Method Parameters

key

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

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

Method Parameters

tClass
key

getString( String key )

public java.lang.String getString(String key)

Method Parameters

key

getInteger( String key )

public java.lang.Integer getInteger(String key)

Method Parameters

key

getFloat( String key )

public java.lang.Float getFloat(String key)

Method Parameters

key

getDouble( String key )

public java.lang.Double getDouble(String key)

Method Parameters

key

getBoolean( String key )

public java.lang.Boolean getBoolean(String key)

Method Parameters

key

getLong( String key )

public java.lang.Long getLong(String key)

Method Parameters

key

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section