Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
UnsubscribeVehicleData

Class UnsubscribeVehicleData

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

This function is used to unsubscribe the notifications from the subscribeVehicleData function

Function Group: Location, VehicleInfo and DrivingChara

HMILevel needs to be FULL, LIMITED or BACKGROUND

Parameter List

Name Type Description Reg. Notes Version
gps Boolean GPS data. See com.smartdevicelink.proxy.rpc.GPSData for details N Subscribable SmartDeviceLink 2.0
speed Boolean The vehicle speed in kilometers per hour N Subscribable SmartDeviceLink 2.0
rpm Boolean The number of revolutions per minute of the engine N Subscribable SmartDeviceLink 2.0
fuelLevel Boolean The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange. N Subscribable SmartDeviceLink 7.0.0
fuelLevel_State Boolean The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange. N Subscribable SmartDeviceLink 7.0.0
fuelRange Boolean The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details. N Subscribable SmartDeviceLink 5.0.0
instantFuelConsumption Boolean The instantaneous fuel consumption in micro litres N Subscribable SmartDeviceLink 2.0
externalTemperature Boolean The external temperature in degrees celsius N Subscribable SmartDeviceLink 2.0
gearStatus Boolean See GearStatus N SmartDeviceLink 7.0.0
prndl Boolean See PRNDL. This parameter is deprecated and it is now covered in `gearStatus` N SmartDeviceLink 7.0.0
tirePressure Boolean Tire pressure status N Subscribable SmartDeviceLink 2.0
odometer Boolean Odometer in km N Max Length: 500 SmartDeviceLink 2.0
beltStatus Boolean The status of the seat belts N Subscribable SmartDeviceLink 2.0
bodyInformation Boolean The body information including ignition status and internal temp N Subscribable SmartDeviceLink 2.0
deviceStatus Boolean The device status including signal and battery strength N Subscribable SmartDeviceLink 2.0
driverBraking Boolean The status of the brake pedal N Subscribable SmartDeviceLink 2.0
wiperStatus Boolean The status of the wipers N Subscribable SmartDeviceLink 2.0
headLampStatus Boolean Status of the head lamps N Subscribable SmartDeviceLink 2.0
engineTorque Boolean Torque value for engine (in Nm) on non-diesel variants N Subscribable SmartDeviceLink 2.0
engineOilLife Boolean The estimated percentage of remaining oil life of the engine N Subscribable SmartDeviceLink 5.0
accPedalPosition Boolean Accelerator pedal position (percentage depressed) N Subscribable SmartDeviceLink 2.0
steeringWheelAngle Boolean Current angle of the steering wheel (in deg) N Subscribable SmartDeviceLink 2.0
eCallInfo Boolean Emergency Call notification and confirmation data. N Subscribable SmartDeviceLink 2.0
airbagStatus Boolean The status of the air bags. N Subscribable SmartDeviceLink 2.0
emergencyEvent Boolean Information related to an emergency event (and if it occurred). N Subscribable SmartDeviceLink 2.0
clusterModeStatus Boolean The status modes of the instrument panel cluster. N Subscribable SmartDeviceLink 2.0
myKey Boolean Information related to the MyKey feature. N Subscribable SmartDeviceLink 2.0
turnSignal Boolean @see TurnSignal N Subscribable SmartDeviceLink 5.0
handsOffSteering Boolean To indicate whether driver hands are off the steering wheel N SmartDeviceLink 7.0.0
windowStatus Boolean See WindowStatus N SmartDeviceLink 7.0.0
stabilityControlsStatus Boolean See StabilityControlsStatus N SmartDeviceLink 7.0.0

Response

Non-default Result Codes:

SUCCESS

WARNINGS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

IGNORED

DISALLOWED

Quick Jump

Fields
Constructors
Methods

Fields

KEY_SPEED

public static final java.lang.String KEY_SPEED
Constant Value
"speed"

KEY_RPM

public static final java.lang.String KEY_RPM
Constant Value
"rpm"

KEY_EXTERNAL_TEMPERATURE

public static final java.lang.String KEY_EXTERNAL_TEMPERATURE
Constant Value
"externalTemperature"

KEY_PRNDL

public static final java.lang.String KEY_PRNDL
Constant Value
"prndl"

KEY_TIRE_PRESSURE

public static final java.lang.String KEY_TIRE_PRESSURE
Constant Value
"tirePressure"

KEY_ENGINE_TORQUE

public static final java.lang.String KEY_ENGINE_TORQUE
Constant Value
"engineTorque"

KEY_ENGINE_OIL_LIFE

public static final java.lang.String KEY_ENGINE_OIL_LIFE
Constant Value
"engineOilLife"

KEY_ODOMETER

public static final java.lang.String KEY_ODOMETER
Constant Value
"odometer"

KEY_GPS

public static final java.lang.String KEY_GPS
Constant Value
"gps"

KEY_INSTANT_FUEL_CONSUMPTION

public static final java.lang.String KEY_INSTANT_FUEL_CONSUMPTION
Constant Value
"instantFuelConsumption"

KEY_BELT_STATUS

public static final java.lang.String KEY_BELT_STATUS
Constant Value
"beltStatus"

KEY_BODY_INFORMATION

public static final java.lang.String KEY_BODY_INFORMATION
Constant Value
"bodyInformation"

KEY_DEVICE_STATUS

public static final java.lang.String KEY_DEVICE_STATUS
Constant Value
"deviceStatus"

KEY_DRIVER_BRAKING

public static final java.lang.String KEY_DRIVER_BRAKING
Constant Value
"driverBraking"

KEY_WIPER_STATUS

public static final java.lang.String KEY_WIPER_STATUS
Constant Value
"wiperStatus"

KEY_HEAD_LAMP_STATUS

public static final java.lang.String KEY_HEAD_LAMP_STATUS
Constant Value
"headLampStatus"

KEY_ACC_PEDAL_POSITION

public static final java.lang.String KEY_ACC_PEDAL_POSITION
Constant Value
"accPedalPosition"

KEY_STEERING_WHEEL_ANGLE

public static final java.lang.String KEY_STEERING_WHEEL_ANGLE
Constant Value
"steeringWheelAngle"

KEY_E_CALL_INFO

public static final java.lang.String KEY_E_CALL_INFO
Constant Value
"eCallInfo"

KEY_AIRBAG_STATUS

public static final java.lang.String KEY_AIRBAG_STATUS
Constant Value
"airbagStatus"

KEY_EMERGENCY_EVENT

public static final java.lang.String KEY_EMERGENCY_EVENT
Constant Value
"emergencyEvent"

KEY_CLUSTER_MODE_STATUS

public static final java.lang.String KEY_CLUSTER_MODE_STATUS
Constant Value
"clusterModeStatus"

KEY_MY_KEY

public static final java.lang.String KEY_MY_KEY
Constant Value
"myKey"

KEY_FUEL_RANGE

public static final java.lang.String KEY_FUEL_RANGE
Constant Value
"fuelRange"

KEY_TURN_SIGNAL

public static final java.lang.String KEY_TURN_SIGNAL
Constant Value
"turnSignal"

KEY_ELECTRONIC_PARK_BRAKE_STATUS

public static final java.lang.String KEY_ELECTRONIC_PARK_BRAKE_STATUS
Constant Value
"electronicParkBrakeStatus"

KEY_CLOUD_APP_VEHICLE_ID

public static final java.lang.String KEY_CLOUD_APP_VEHICLE_ID
Constant Value
"cloudAppVehicleID"

KEY_HANDS_OFF_STEERING

public static final java.lang.String KEY_HANDS_OFF_STEERING
Constant Value
"handsOffSteering"

KEY_GEAR_STATUS

public static final java.lang.String KEY_GEAR_STATUS
Constant Value
"gearStatus"

KEY_WINDOW_STATUS

public static final java.lang.String KEY_WINDOW_STATUS
Constant Value
"windowStatus"

KEY_FUEL_LEVEL

public static final java.lang.String KEY_FUEL_LEVEL
Constant Value
"fuelLevel"

KEY_FUEL_LEVEL_STATE

public static final java.lang.String KEY_FUEL_LEVEL_STATE
Constant Value
"fuelLevel_State"

KEY_STABILITY_CONTROLS_STATUS

public static final java.lang.String KEY_STABILITY_CONTROLS_STATUS
Constant Value
"stabilityControlsStatus"

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

UnsubscribeVehicleData()

Constructs a new UnsubscribeVehicleData object

public UnsubscribeVehicleData()

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

Constructs a new UnsubscribeVehicleData object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

Methods

setGps( Boolean gps )

Sets a boolean value. If true, unsubscribes from Gps data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setGps(Boolean gps)

Parameters

gps
a boolean value

getGps()

Gets a boolean value. If true, means the Gps data has been unsubscribed.

public java.lang.Boolean getGps()

setSpeed( Boolean speed )

Sets a boolean value. If true, unsubscribes from speed data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setSpeed(Boolean speed)

Parameters

speed
a boolean value

getSpeed()

Gets a boolean value. If true, means the Speed data has been unsubscribed.

public java.lang.Boolean getSpeed()

setRpm( Boolean rpm )

Sets a boolean value. If true, unsubscribe data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setRpm(Boolean rpm)

Parameters

rpm
a boolean value

getRpm()

Gets a boolean value. If true, means the rpm data has been unsubscribed.

public java.lang.Boolean getRpm()

setFuelLevel( Boolean fuelLevel )

Deprecated
Sets the fuelLevel.

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setFuelLevel(Boolean fuelLevel)

Parameters

fuelLevel
The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.

getFuelLevel()

Deprecated
Gets the fuelLevel.

public java.lang.Boolean getFuelLevel()

setFuelLevelState( Boolean fuelLevelState )

Deprecated
Sets the fuelRange.

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setFuelLevelState(Boolean fuelLevelState)

Parameters

fuelLevelState
The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.

getFuelLevelState()

Deprecated
Gets the fuelRange.

public java.lang.Boolean getFuelLevelState()

setInstantFuelConsumption( Boolean instantFuelConsumption )

Sets a boolean value. If true, unsubscribes from instantFuelConsumption data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setInstantFuelConsumption(Boolean instantFuelConsumption)

Parameters

instantFuelConsumption
a boolean value

getInstantFuelConsumption()

Gets a boolean value. If true, means the getInstantFuelConsumption data has been unsubscribed.

public java.lang.Boolean getInstantFuelConsumption()

setExternalTemperature( Boolean externalTemperature )

Sets a boolean value. If true, unsubscribes from externalTemperature data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setExternalTemperature(Boolean externalTemperature)

Parameters

externalTemperature
a boolean value

getExternalTemperature()

Gets a boolean value. If true, means the externalTemperature data has been unsubscribed.

public java.lang.Boolean getExternalTemperature()

setPrndl( Boolean prndl )

Deprecated
Sets the prndl.

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setPrndl(Boolean prndl)

Parameters

prndl
See PRNDL. This parameter since SmartDeviceLink 7.0.0 is deprecated and it is now covered in `gearStatus`

getPrndl()

Deprecated
Gets the prndl.

public java.lang.Boolean getPrndl()

setTirePressure( Boolean tirePressure )

Sets a boolean value. If true, unsubscribes from tire pressure status data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setTirePressure(Boolean tirePressure)

Parameters

tirePressure
a boolean value

getTirePressure()

Gets a boolean value. If true, means the tire pressure status data has been unsubscribed.

public java.lang.Boolean getTirePressure()

setOdometer( Boolean odometer )

Sets a boolean value. If true, unsubscribes from odometer data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setOdometer(Boolean odometer)

Parameters

odometer
a boolean value

getOdometer()

Gets a boolean value. If true, means the odometer data has been unsubscribed.

public java.lang.Boolean getOdometer()

setBeltStatus( Boolean beltStatus )

Sets a boolean value. If true, unsubscribes from belt Status data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setBeltStatus(Boolean beltStatus)

Parameters

beltStatus
a boolean value

getBeltStatus()

Gets a boolean value. If true, means the belt Status data has been unsubscribed.

public java.lang.Boolean getBeltStatus()

setBodyInformation( Boolean bodyInformation )

Sets a boolean value. If true, unsubscribes from body Information data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setBodyInformation(Boolean bodyInformation)

Parameters

bodyInformation
a boolean value

getBodyInformation()

Gets a boolean value. If true, means the body Information data has been unsubscribed.

public java.lang.Boolean getBodyInformation()

setDeviceStatus( Boolean deviceStatus )

Sets a boolean value. If true, unsubscribes from device Status data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setDeviceStatus(Boolean deviceStatus)

Parameters

deviceStatus
a boolean value

getDeviceStatus()

Gets a boolean value. If true, means the device Status data has been unsubscribed.

public java.lang.Boolean getDeviceStatus()

setDriverBraking( Boolean driverBraking )

Sets a boolean value. If true, unsubscribes from driver Braking data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setDriverBraking(Boolean driverBraking)

Parameters

driverBraking
a boolean value

getDriverBraking()

Gets a boolean value. If true, means the driver Braking data has been unsubscribed.

public java.lang.Boolean getDriverBraking()

setWiperStatus( Boolean wiperStatus )

Sets a boolean value. If true, unsubscribes from wiper Status data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setWiperStatus(Boolean wiperStatus)

Parameters

wiperStatus
a boolean value

getWiperStatus()

Gets a boolean value. If true, means the wiper Status data has been unsubscribed.

public java.lang.Boolean getWiperStatus()

setHeadLampStatus( Boolean headLampStatus )

Sets a boolean value. If true, unsubscribes from Head Lamp Status data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setHeadLampStatus(Boolean headLampStatus)

Parameters

headLampStatus
a boolean value

getHeadLampStatus()

Gets a boolean value. If true, means the Head Lamp Status data has been unsubscribed.

public java.lang.Boolean getHeadLampStatus()

setEngineTorque( Boolean engineTorque )

Sets a boolean value. If true, unsubscribes from Engine Torque data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setEngineTorque(Boolean engineTorque)

Parameters

engineTorque
a boolean value

getEngineTorque()

Gets a boolean value. If true, means the Engine Torque data has been unsubscribed.

public java.lang.Boolean getEngineTorque()

setEngineOilLife( Boolean engineOilLife )

Sets a boolean value. If true, unsubscribes from Engine Oil Life data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setEngineOilLife(Boolean engineOilLife)

Parameters

engineOilLife
a boolean value

getEngineOilLife()

Gets a boolean value. If true, means the Engine Oil Life data has been unsubscribed.

public java.lang.Boolean getEngineOilLife()

setAccPedalPosition( Boolean accPedalPosition )

Sets a boolean value. If true, unsubscribes from accPedalPosition data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setAccPedalPosition(Boolean accPedalPosition)

Parameters

accPedalPosition
a boolean value

getAccPedalPosition()

Gets a boolean value. If true, means the accPedalPosition data has been unsubscribed.

public java.lang.Boolean getAccPedalPosition()

setSteeringWheelAngle( Boolean steeringWheelAngle )

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setSteeringWheelAngle(Boolean steeringWheelAngle)

Parameters

steeringWheelAngle

getSteeringWheelAngle()

public java.lang.Boolean getSteeringWheelAngle()

setECallInfo( Boolean eCallInfo )

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setECallInfo(Boolean eCallInfo)

Parameters

eCallInfo

getECallInfo()

public java.lang.Boolean getECallInfo()

setAirbagStatus( Boolean airbagStatus )

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setAirbagStatus(Boolean airbagStatus)

Parameters

airbagStatus

getAirbagStatus()

public java.lang.Boolean getAirbagStatus()

setEmergencyEvent( Boolean emergencyEvent )

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setEmergencyEvent(Boolean emergencyEvent)

Parameters

emergencyEvent

getEmergencyEvent()

public java.lang.Boolean getEmergencyEvent()

setClusterModeStatus( Boolean clusterModeStatus )

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setClusterModeStatus(Boolean clusterModeStatus)

Parameters

clusterModeStatus

getClusterModeStatus()

public java.lang.Boolean getClusterModeStatus()

setMyKey( Boolean myKey )

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setMyKey(Boolean myKey)

Parameters

myKey

getMyKey()

public java.lang.Boolean getMyKey()

setFuelRange( Boolean fuelRange )

Sets a boolean value. If true, unsubscribes from fuelRange data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setFuelRange(Boolean fuelRange)

Parameters

fuelRange
a boolean value

getFuelRange()

Gets a boolean value. If true, means the fuelRange data has been unsubscribed.

public java.lang.Boolean getFuelRange()

setTurnSignal( Boolean turnSignal )

Sets a boolean value. If true, unsubscribes from turnSignal data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setTurnSignal(Boolean turnSignal)

Parameters

turnSignal
a boolean value

getTurnSignal()

Gets a boolean value. If true, means the turnSignal data has been unsubscribed.

public java.lang.Boolean getTurnSignal()

setElectronicParkBrakeStatus( Boolean electronicParkBrakeStatus )

Sets a boolean value. If true, unsubscribes from electronicParkBrakeStatus data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setElectronicParkBrakeStatus(Boolean electronicParkBrakeStatus)

Parameters

electronicParkBrakeStatus
a boolean value

getElectronicParkBrakeStatus()

Gets a boolean value. If true, means the electronicParkBrakeStatus data has been subscribed.

public java.lang.Boolean getElectronicParkBrakeStatus()

setCloudAppVehicleID( boolean cloudAppVehicleID )

Sets a boolean value. If true, unsubscribes from cloudAppVehicleID data

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setCloudAppVehicleID(boolean cloudAppVehicleID)

Parameters

cloudAppVehicleID
a boolean value.

getCloudAppVehicleID()

Gets a boolean value. If true, means the cloudAppVehicleID data has been unsubscribed.

public java.lang.Boolean getCloudAppVehicleID()

setOEMCustomVehicleData( String vehicleDataName, Boolean vehicleDataState )

Sets a boolean value for OEM Custom VehicleData.

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setOEMCustomVehicleData(String vehicleDataName,Boolean vehicleDataState)

Parameters

vehicleDataName
a String value
vehicleDataState
a boolean value

getOEMCustomVehicleData( String vehicleDataName )

Gets a boolean value for OEM Custom VehicleData.

public java.lang.Boolean getOEMCustomVehicleData(String vehicleDataName)

Parameters

vehicleDataName

setGearStatus( Boolean gearStatus )

Sets the gearStatus.

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setGearStatus(Boolean gearStatus)

Parameters

gearStatus
See GearStatus

getGearStatus()

Gets the gearStatus.

public java.lang.Boolean getGearStatus()

setHandsOffSteering( Boolean handsOffSteering )

Sets the handsOffSteering.

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setHandsOffSteering(Boolean handsOffSteering)

Parameters

handsOffSteering
To indicate whether driver hands are off the steering wheel

getHandsOffSteering()

Gets the handsOffSteering.

public java.lang.Boolean getHandsOffSteering()

setWindowStatus( Boolean windowStatus )

Sets the windowStatus.

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setWindowStatus(Boolean windowStatus)

Parameters

windowStatus
See WindowStatus

getWindowStatus()

Gets the windowStatus.

public java.lang.Boolean getWindowStatus()

setStabilityControlsStatus( Boolean stabilityControlsStatus )

Sets the stabilityControlsStatus.

public com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData setStabilityControlsStatus(Boolean stabilityControlsStatus)

Parameters

stabilityControlsStatus
See StabilityControlsStatus

getStabilityControlsStatus()

Gets the stabilityControlsStatus.

public java.lang.Boolean getStabilityControlsStatus()

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, 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