com.smartdevicelink.proxy.rpc

Class GetInteriorVehicleData

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.GetInteriorVehicleData

All Implemented Interfaces:

Cloneable

public class GetInteriorVehicleData
extends RPCRequest

Read the current status value of specified remote control module (type). In addition, When subscribe=true, subscribes for specific remote control module data items; When subscribe=false, un-subscribes for specific remote control module data items. Once subscribed, the application will be notified by the onInteriorVehicleData notification whenever new data is available for the module.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_MODULE_ID
static String	KEY_MODULE_TYPE
static String	KEY_SUBSCRIBE

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
GetInteriorVehicleData() Constructs a new GetInteriorVehicleData object
GetInteriorVehicleData(Hashtable<String,Object> hash) Constructs a new GetInteriorVehicleData object indicated by the Hashtable parameter
GetInteriorVehicleData(ModuleType moduleType) Constructs a new GetInteriorVehicleData object

Method Summary

Modifier and Type	Method and Description
String	getModuleId() Gets the Module ID of this class
ModuleType	getModuleType() Gets the ModuleType
Boolean	getSubscribe() Gets subscribe parameter
GetInteriorVehicleData	setModuleId(String id) Sets the Module ID for this class
GetInteriorVehicleData	setModuleType(ModuleType moduleType) Sets a ModuleType
GetInteriorVehicleData	setSubscribe(Boolean subscribe) Sets subscribe parameter

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_MODULE_TYPE

public static final String KEY_MODULE_TYPE

See Also:

Constant Field Values

KEY_SUBSCRIBE

public static final String KEY_SUBSCRIBE

See Also:

Constant Field Values

KEY_MODULE_ID

public static final String KEY_MODULE_ID

See Also:

Constant Field Values

Constructor Detail

GetInteriorVehicleData

public GetInteriorVehicleData()

Constructs a new GetInteriorVehicleData object

GetInteriorVehicleData

public GetInteriorVehicleData(Hashtable<String,Object> hash)

Constructs a new GetInteriorVehicleData object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

GetInteriorVehicleData

public GetInteriorVehicleData(@NonNull
                              ModuleType moduleType)

Constructs a new GetInteriorVehicleData object

Method Detail

getModuleType

public ModuleType getModuleType()

Gets the ModuleType

Returns:

ModuleType - The type of a RC module to retrieve module data from the vehicle. In the future, this should be the Identification of a module.

setModuleType

public GetInteriorVehicleData setModuleType(@NonNull
                                            ModuleType moduleType)

Sets a ModuleType

Parameters:

moduleType - The type of a RC module to retrieve module data from the vehicle. In the future, this should be the Identification of a module.

setSubscribe

public GetInteriorVehicleData setSubscribe(Boolean subscribe)

Sets subscribe parameter

Parameters:

subscribe - If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduleType. If subscribe is false, the head unit will unregister onInteriorVehicleData notifications for the requested moduleType.

getSubscribe

public Boolean getSubscribe()

Gets subscribe parameter

Returns:

Boolean - If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduelType. If subscribe is false, the head unit will unregister onInteriorVehicleData notifications for the requested moduelType.

setModuleId

public GetInteriorVehicleData setModuleId(String id)

Sets the Module ID for this class

Parameters:

id - the id to be set

getModuleId

public String getModuleId()

Gets the Module ID of this class

Returns:

the Module ID of this class