com.smartdevicelink.proxy.rpc

Class ButtonCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.ButtonCapabilities

All Implemented Interfaces:

Cloneable

public class ButtonCapabilities
extends RPCStruct

Provides information about the capabilities of a SDL HMI button.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
name	ButtonName	The name of theSDL HMI button.	SmartDeviceLink 1.0
shortPressAvailable	Boolean	The button supports a SHORT press. See ButtonPressMode for more information.	SmartDeviceLink 1.0
longPressAvailable	Boolean	The button supports a LONG press. See ButtonPressMode for more information.	SmartDeviceLink 1.0
upDownAvailable	Boolean	The button supports "button down" and "button up". When the button is depressed, the OnButtonEvent notification will be invoked with a value of BUTTONDOWN. When the button is released, the OnButtonEvent notification will be invoked with a value of BUTTONUP.	SmartDeviceLink 1.0

Upon the request HMI must provide the list of the following information:

The names of all existing/supported hardware buttons.

The availability of LONG/SHORT press for each existing/supported hardware button correspondingly

The availability of UP/DOWN events for each existing/supported hardware button correspondingly.

Since:

SmartDeviceLink 1.0

See Also:

ButtonName, ButtonEventMode, ButtonPressMode, OnButtonEvent, OnButtonPress

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_LONG_PRESS_AVAILABLE
static String	KEY_MODULE_INFO
static String	KEY_NAME
static String	KEY_SHORT_PRESS_AVAILABLE
static String	KEY_UP_DOWN_AVAILABLE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
ButtonCapabilities() Constructs a newly allocated ButtonCapabilities object
ButtonCapabilities(ButtonName name, Boolean shortPressAvailable, Boolean longPressAvailable, Boolean upDownAvailable) Constructs a newly allocated ButtonCapabilities object
ButtonCapabilities(Hashtable<String,Object> hash) Constructs a newly allocated ButtonCapabilities object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
Boolean	getLongPressAvailable() Whether the button supports a LONG press.
ModuleInfo	getModuleInfo() Gets a ModuleInfo of this capability
ButtonName	getName() Get the name of theSDL HMI button.
Boolean	getShortPressAvailable() Whether the button supports a SHORT press.
Boolean	getUpDownAvailable() Whether the button supports "button down" and "button up".
ButtonCapabilities	setLongPressAvailable(Boolean longPressAvailable) Set the button supports a LONG press.
ButtonCapabilities	setModuleInfo(ModuleInfo info) Sets ModuleInfo for this capability
ButtonCapabilities	setName(ButtonName name) Set the name of theSDL HMI button.
ButtonCapabilities	setShortPressAvailable(Boolean shortPressAvailable) Set the button supports a SHORT press.
ButtonCapabilities	setUpDownAvailable(Boolean upDownAvailable) Set the button supports "button down" and "button up".

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, 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_NAME

public static final String KEY_NAME

See Also:

Constant Field Values

KEY_SHORT_PRESS_AVAILABLE

public static final String KEY_SHORT_PRESS_AVAILABLE

See Also:

Constant Field Values

KEY_LONG_PRESS_AVAILABLE

public static final String KEY_LONG_PRESS_AVAILABLE

See Also:

Constant Field Values

KEY_UP_DOWN_AVAILABLE

public static final String KEY_UP_DOWN_AVAILABLE

See Also:

Constant Field Values

KEY_MODULE_INFO

public static final String KEY_MODULE_INFO

See Also:

Constant Field Values

Constructor Detail

ButtonCapabilities

public ButtonCapabilities()

Constructs a newly allocated ButtonCapabilities object

ButtonCapabilities

public ButtonCapabilities(Hashtable<String,Object> hash)

Constructs a newly allocated ButtonCapabilities object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

ButtonCapabilities

public ButtonCapabilities(@NonNull
                          ButtonName name,
                          @NonNull
                          Boolean shortPressAvailable,
                          @NonNull
                          Boolean longPressAvailable,
                          @NonNull
                          Boolean upDownAvailable)

Constructs a newly allocated ButtonCapabilities object

Parameters:

name - the name of button

shortPressAvailable - True if support otherwise False.

longPressAvailable - True if support otherwise False.

upDownAvailable - True if support otherwise False.

Method Detail

getName

public ButtonName getName()

Get the name of theSDL HMI button.

Returns:

ButtonName the name of the Button

setName

public ButtonCapabilities setName(@NonNull
                                  ButtonName name)

Set the name of theSDL HMI button.

Parameters:

name - the name of button

getShortPressAvailable

public Boolean getShortPressAvailable()

Whether the button supports a SHORT press. See ButtonPressMode for more information.

Returns:

True if support otherwise False.

setShortPressAvailable

public ButtonCapabilities setShortPressAvailable(@NonNull
                                                 Boolean shortPressAvailable)

Set the button supports a SHORT press. See ButtonPressMode for more information.

Parameters:

shortPressAvailable - True if support otherwise False.

getLongPressAvailable

public Boolean getLongPressAvailable()

Whether the button supports a LONG press. See ButtonPressMode for more information.

Returns:

True if support otherwise False.

setLongPressAvailable

public ButtonCapabilities setLongPressAvailable(@NonNull
                                                Boolean longPressAvailable)

Set the button supports a LONG press. See ButtonPressMode for more information.

Parameters:

longPressAvailable - True if support otherwise False.

getUpDownAvailable

public Boolean getUpDownAvailable()

Whether the button supports "button down" and "button up". When the button is depressed, the OnButtonEvent notification will be invoked with a value of BUTTONDOWN.

Returns:

True if support otherwise False.

setUpDownAvailable

public ButtonCapabilities setUpDownAvailable(@NonNull
                                             Boolean upDownAvailable)

Set the button supports "button down" and "button up". When the button is depressed, the OnButtonEvent notification will be invoked with a value of BUTTONDOWN.

Parameters:

upDownAvailable - True if support otherwise False.

setModuleInfo

public ButtonCapabilities setModuleInfo(ModuleInfo info)

Sets ModuleInfo for this capability

Parameters:

info - the ModuleInfo to be set

getModuleInfo

public ModuleInfo getModuleInfo()

Gets a ModuleInfo of this capability

Returns:

module info of this capability