BodyInformation Class Reference
Constructors
Instance Methods
- getDoorStatuses() ⇒
Array.<DoorStatus> - getDriverDoorAjar() ⇒
Boolean - getGateStatuses() ⇒
Array.<GateStatus> - getIgnitionStableStatus() ⇒
IgnitionStableStatus - getIgnitionStatus() ⇒
IgnitionStatus - getParkBrakeActive() ⇒
Boolean - getPassengerDoorAjar() ⇒
Boolean - getRearLeftDoorAjar() ⇒
Boolean - getRearRightDoorAjar() ⇒
Boolean - getRoofStatuses() ⇒
Array.<RoofStatus> - setDoorStatuses(statuses) ⇒
BodyInformation - setDriverDoorAjar(ajar) ⇒
BodyInformation - setGateStatuses(statuses) ⇒
BodyInformation - setIgnitionStableStatus(status) ⇒
BodyInformation - setIgnitionStatus(status) ⇒
BodyInformation - setParkBrakeActive(active) ⇒
BodyInformation - setPassengerDoorAjar(ajar) ⇒
BodyInformation - setRearLeftDoorAjar(ajar) ⇒
BodyInformation - setRearRightDoorAjar(ajar) ⇒
BodyInformation - setRoofStatuses(statuses) ⇒
BodyInformation
Instance Methods
bodyInformation.getDoorStatuses() ⇒ Array.<DoorStatus>
Get the DoorStatuses
Kind: Instance method of BodyInformation
Returns: Array.<DoorStatus> - the KEY_DOOR_STATUSES value
bodyInformation.getDriverDoorAjar() ⇒ Boolean
Get the DriverDoorAjar
Kind: Instance method of BodyInformation
Returns: Boolean - the KEY_DRIVER_DOOR_AJAR value
bodyInformation.getGateStatuses() ⇒ Array.<GateStatus>
Get the GateStatuses
Kind: Instance method of BodyInformation
Returns: Array.<GateStatus> - the KEY_GATE_STATUSES value
bodyInformation.getIgnitionStableStatus() ⇒ IgnitionStableStatus
Get the IgnitionStableStatus
Kind: Instance method of BodyInformation
Returns: IgnitionStableStatus - the KEY_IGNITION_STABLE_STATUS value
bodyInformation.getIgnitionStatus() ⇒ IgnitionStatus
Get the IgnitionStatus
Kind: Instance method of BodyInformation
Returns: IgnitionStatus - the KEY_IGNITION_STATUS value
bodyInformation.getParkBrakeActive() ⇒ Boolean
Get the ParkBrakeActive
Kind: Instance method of BodyInformation
Returns: Boolean - the KEY_PARK_BRAKE_ACTIVE value
bodyInformation.getPassengerDoorAjar() ⇒ Boolean
Get the PassengerDoorAjar
Kind: Instance method of BodyInformation
Returns: Boolean - the KEY_PASSENGER_DOOR_AJAR value
bodyInformation.getRearLeftDoorAjar() ⇒ Boolean
Get the RearLeftDoorAjar
Kind: Instance method of BodyInformation
Returns: Boolean - the KEY_REAR_LEFT_DOOR_AJAR value
bodyInformation.getRearRightDoorAjar() ⇒ Boolean
Get the RearRightDoorAjar
Kind: Instance method of BodyInformation
Returns: Boolean - the KEY_REAR_RIGHT_DOOR_AJAR value
bodyInformation.getRoofStatuses() ⇒ Array.<RoofStatus>
Get the RoofStatuses
Kind: Instance method of BodyInformation
Returns: Array.<RoofStatus> - the KEY_ROOF_STATUSES value
bodyInformation.setDoorStatuses(statuses) ⇒ BodyInformation
Set the DoorStatuses
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| statuses | Array.<DoorStatus> |
Provides status for doors if Ajar/Closed/Locked - The desired DoorStatuses. {'array_min_size': 0, 'array_max_size': 100} |
bodyInformation.setDriverDoorAjar(ajar) ⇒ BodyInformation
Set the DriverDoorAjar
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| ajar | Boolean |
References signal "DrStatDrv_B_Actl". Deprecated starting with RPC Spec 7.1.0. - The desired DriverDoorAjar. |
bodyInformation.setGateStatuses(statuses) ⇒ BodyInformation
Set the GateStatuses
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| statuses | Array.<GateStatus> |
Provides status for trunk/hood/etc. if Ajar/Closed/Locked - The desired GateStatuses. {'array_min_size': 0, 'array_max_size': 100} |
bodyInformation.setIgnitionStableStatus(status) ⇒ BodyInformation
Set the IgnitionStableStatus
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | IgnitionStableStatus |
References signal "Ignition_Switch_Stable". See IgnitionStableStatus. - The desired IgnitionStableStatus. |
bodyInformation.setIgnitionStatus(status) ⇒ BodyInformation
Set the IgnitionStatus
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| status | IgnitionStatus |
References signal "Ignition_status". See IgnitionStatus. - The desired IgnitionStatus. |
bodyInformation.setParkBrakeActive(active) ⇒ BodyInformation
Set the ParkBrakeActive
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| active | Boolean |
References signal "PrkBrkActv_B_Actl". - The desired ParkBrakeActive. |
bodyInformation.setPassengerDoorAjar(ajar) ⇒ BodyInformation
Set the PassengerDoorAjar
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| ajar | Boolean |
References signal "DrStatPsngr_B_Actl". Deprecated starting with RPC Spec 7.1.0. - The desired PassengerDoorAjar. |
bodyInformation.setRearLeftDoorAjar(ajar) ⇒ BodyInformation
Set the RearLeftDoorAjar
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| ajar | Boolean |
References signal "DrStatRl_B_Actl". Deprecated starting with RPC Spec 7.1.0. - The desired RearLeftDoorAjar. |
bodyInformation.setRearRightDoorAjar(ajar) ⇒ BodyInformation
Set the RearRightDoorAjar
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| ajar | Boolean |
References signal "DrStatRr_B_Actl". Deprecated starting with RPC Spec 7.1.0. - The desired RearRightDoorAjar. |
bodyInformation.setRoofStatuses(statuses) ⇒ BodyInformation
Set the RoofStatuses
Kind: Instance method of BodyInformation
Returns: BodyInformation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| statuses | Array.<RoofStatus> |
Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removed etc. - The desired RoofStatuses. {'array_min_size': 0, 'array_max_size': 100} |