com.smartdevicelink.proxy.rpc

Class SendHapticData

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.SendHapticData

All Implemented Interfaces:

Cloneable

public class SendHapticData
extends RPCRequest

Request to describe UI elements boundaries to a connected modules.

Since:

SmartDeviceLink 4.5.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_HAPTIC_RECT_DATA

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
SendHapticData() Constructs a new SendHapticData object
SendHapticData(Hashtable<String,Object> hash) Send the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI.

Method Summary

Modifier and Type	Method and Description
List<HapticRect>	getHapticRectData() Get the haptic data
SendHapticData	setHapticRectData(List<HapticRect> hapticRectData) Array of spatial data structures that represent the locations of all user controls present on the app's layout.

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_HAPTIC_RECT_DATA

public static final String KEY_HAPTIC_RECT_DATA

See Also:

Constant Field Values

Constructor Detail

SendHapticData

public SendHapticData()

Constructs a new SendHapticData object

SendHapticData

public SendHapticData(Hashtable<String,Object> hash)

Send the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI. This data will be utilized by the HMI to determine how and when haptic events should occur

Parameters:

hash - The Hashtable to use

Method Detail

setHapticRectData

public SendHapticData setHapticRectData(List<HapticRect> hapticRectData)

Array of spatial data structures that represent the locations of all user controls present on the app's layout. This data should be updated if/when the application presents a new screen. When a request is sent, if successful, it will replace all spatial data previously sent through RPC. If an empty array is sent, the existing spatial data will be cleared

getHapticRectData

public List<HapticRect> getHapticRectData()

Get the haptic data

Returns:

array of spatial data structures that represent the locations of all user controls present on the app's layout.