GetInteriorVehicleData Class Reference
Constructors
Instance Methods
- getModuleId() ⇒
String - getModuleType() ⇒
ModuleType - getSubscribe() ⇒
Boolean - setModuleId(id) ⇒
GetInteriorVehicleData - setModuleType(type) ⇒
GetInteriorVehicleData - setSubscribe(subscribe) ⇒
GetInteriorVehicleData
Constructors
new GetInteriorVehicleData(parameters)
Initializes an instance of GetInteriorVehicleData.
Instance Methods
getInteriorVehicleData.getModuleId() ⇒ String
Get the ModuleId
Kind: Instance method of GetInteriorVehicleData
Returns: String - the KEY_MODULE_ID value
getInteriorVehicleData.getModuleType() ⇒ ModuleType
Get the ModuleType
Kind: Instance method of GetInteriorVehicleData
Returns: ModuleType - the KEY_MODULE_TYPE value
getInteriorVehicleData.getSubscribe() ⇒ Boolean
Get the Subscribe
Kind: Instance method of GetInteriorVehicleData
Returns: Boolean - the KEY_SUBSCRIBE value
getInteriorVehicleData.setModuleId(id) ⇒ GetInteriorVehicleData
Set the ModuleId
Kind: Instance method of GetInteriorVehicleData
Returns: GetInteriorVehicleData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | String |
Id of a module, published by System Capability. - The desired ModuleId. {'string_min_length': 1, 'string_max_length': 100} |
getInteriorVehicleData.setModuleType(type) ⇒ GetInteriorVehicleData
Set the ModuleType
Kind: Instance method of GetInteriorVehicleData
Returns: GetInteriorVehicleData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| type | ModuleType |
The type of an RC module to retrieve module data from the vehicle. In the future, this should be the Identification of a module. - The desired ModuleType. |
getInteriorVehicleData.setSubscribe(subscribe) ⇒ GetInteriorVehicleData
Set the Subscribe
Kind: Instance method of GetInteriorVehicleData
Returns: GetInteriorVehicleData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| subscribe | Boolean |
If subscribe is true, the head unit will register OnInteriorVehicleData notifications for the requested module (moduleId and moduleType). If subscribe is false, the head unit will unregister OnInteriorVehicleData notifications for the requested module (moduleId and moduleType). If subscribe is not included, the subscription status of the app for the requested module (moduleId and moduleType) will remain unchanged. - The desired Subscribe. |