com.smartdevicelink.proxy.rpc

Class UnsubscribeButton

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.UnsubscribeButton

All Implemented Interfaces:

Cloneable

public class UnsubscribeButton
extends RPCRequest

Deletes a subscription to button notifications for the specified button. For more information about button subscriptions, see SubscribeButton

Application 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

Since:

SmartDeviceLink 1.0

See Also:

SubscribeButton

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_BUTTON_NAME

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
UnsubscribeButton() Constructs a new UnsubscribeButton object
UnsubscribeButton(ButtonName buttonName) Constructs a new UnsubscribeButton object
UnsubscribeButton(Hashtable<String,Object> hash) Constructs a new UnsubscribeButton object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
ButtonName	getButtonName() Gets a name of the button to unsubscribe from
UnsubscribeButton	setButtonName(ButtonName buttonName) Sets the name of the button to unsubscribe from

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_BUTTON_NAME

public static final String KEY_BUTTON_NAME

See Also:

Constant Field Values

Constructor Detail

UnsubscribeButton

public UnsubscribeButton()

Constructs a new UnsubscribeButton object

UnsubscribeButton

public UnsubscribeButton(Hashtable<String,Object> hash)

Constructs a new UnsubscribeButton object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

UnsubscribeButton

public UnsubscribeButton(@NonNull
                         ButtonName buttonName)

Constructs a new UnsubscribeButton object

Parameters:

buttonName - Name of the button to unsubscribe.

Method Detail

getButtonName

public ButtonName getButtonName()

Gets a name of the button to unsubscribe from

Returns:

ButtonName -an Enumeration value, see ButtonName

setButtonName

public UnsubscribeButton setButtonName(@NonNull
                                       ButtonName buttonName)

Sets the name of the button to unsubscribe from

Parameters:

buttonName - an enum value, see ButtonName