Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
US
JP
US
JP
JavaSE Documentation
Documentation
GetInteriorVehicleData

Class GetInteriorVehicleData

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

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.

Quick Jump

Fields
Constructors
Methods

Fields

KEY_MODULE_TYPE

public static final java.lang.String KEY_MODULE_TYPE
Constant Value
"moduleType"

KEY_SUBSCRIBE

public static final java.lang.String KEY_SUBSCRIBE
Constant Value
"subscribe"

KEY_MODULE_ID

public static final java.lang.String KEY_MODULE_ID
Constant Value
"moduleId"

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

GetInteriorVehicleData()

Constructs a new GetInteriorVehicleData object 

public GetInteriorVehicleData()

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

Constructs a new GetInteriorVehicleData object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

GetInteriorVehicleData( ModuleType moduleType )

Constructs a new GetInteriorVehicleData object 

public GetInteriorVehicleData(ModuleType moduleType)

Parameters

moduleType

Methods

getModuleType()

Gets the ModuleType 

public com.smartdevicelink.proxy.rpc.enums.ModuleType getModuleType()

setModuleType( ModuleType moduleType )

Sets a ModuleType 

public void setModuleType(ModuleType 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( Boolean subscribe )

Sets subscribe parameter 

public void setSubscribe(Boolean subscribe)

Parameters

subscribe
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.

getSubscribe()

Gets subscribe parameter 

public java.lang.Boolean getSubscribe()

setModuleId( String id )

Sets the Module ID for this class 

public void setModuleId(String id)

Parameters

id
the id to be set

getModuleId()

Gets the Module ID of this class 

public java.lang.String getModuleId()

Inherited Methods

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