Class UnsubscribeButton
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
- Package
- com.smartdevicelink.proxy.rpc
Overview
Deletes a subscription to button notifications for the specified button. For more information about button subscriptions, see SubscribeButtonApplication can unsubscribe from a button that is currently being pressed (i.e. has not yet been released), but app will not get button event
HMILevel needs to be FULL, LIMITED or BACKGROUND
Parameter List
| Param Name | Type | Description | Req. | Notes | Version Available |
|---|---|---|---|---|---|
| buttonName | ButtonName | Name of the button to unsubscribe. | Y | SmartDeviceLink 1.0 |
Response
Non-default Result Codes:
SUCCESS
INVALID_DATA
OUT_OF_MEMORY
TOO_MANY_PENDING_REQUESTS
APPLICATION_NOT_REGISTERED
GENERIC_ERROR
UNSUPPORTED_RESOURCE
IGNORED
REJECTED
Quick Jump
Fields
KEY_BUTTON_NAME
public static final java.lang.String KEY_BUTTON_NAME
- Constant Value
- "buttonName"
Inherited Fields
Constructors
UnsubscribeButton()
Constructs a new UnsubscribeButton object
public UnsubscribeButton()
UnsubscribeButton( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a new UnsubscribeButton object indicated by the Hashtable parameter
public UnsubscribeButton(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
UnsubscribeButton( ButtonName buttonName )
Constructs a new UnsubscribeButton object
public UnsubscribeButton(ButtonName buttonName)
Constructor Parameters
- buttonName
- Name of the button to unsubscribe.
Methods
getButtonName()
Gets a name of the button to unsubscribe from
public com.smartdevicelink.proxy.rpc.enums.ButtonName getButtonName()
setButtonName( ButtonName buttonName )
Sets the name of the button to unsubscribe from
public com.smartdevicelink.proxy.rpc.UnsubscribeButton setButtonName(ButtonName buttonName)
Method Parameters
- buttonName
- an enum value, see {@linkplain ButtonName}
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, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |