com.smartdevicelink.proxy.rpc

Class KeyboardLayoutCapability

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.KeyboardLayoutCapability

All Implemented Interfaces:

Cloneable

public class KeyboardLayoutCapability
extends RPCStruct

Describes the capabilities of a single keyboard layout.

Parameter List

Param Name	Type	Description	Required	Notes	Version Available
keyboardLayout	KeyboardLayout		Y
numConfigurableKeys	Integer	Number of keys available for special characters, App can customize as per their needs.	Y	{"num_max_value": 10, "num_min_value": 0}

Since:

SmartDeviceLink 7.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_KEYBOARD_LAYOUT
static String	KEY_NUM_CONFIGURABLE_KEYS

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
KeyboardLayoutCapability() Constructs a new KeyboardLayoutCapability object
KeyboardLayoutCapability(Hashtable<String,Object> hash) Constructs a new KeyboardLayoutCapability object indicated by the Hashtable parameter
KeyboardLayoutCapability(KeyboardLayout keyboardLayout, Integer numConfigurableKeys) Constructs a new KeyboardLayoutCapability object

Method Summary

Modifier and Type	Method and Description
KeyboardLayout	getKeyboardLayout() Gets the keyboardLayout.
Integer	getNumConfigurableKeys() Gets the numConfigurableKeys.
KeyboardLayoutCapability	setKeyboardLayout(KeyboardLayout keyboardLayout) Sets the keyboardLayout.
KeyboardLayoutCapability	setNumConfigurableKeys(Integer numConfigurableKeys) Sets the numConfigurableKeys.

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_KEYBOARD_LAYOUT

public static final String KEY_KEYBOARD_LAYOUT

See Also:

Constant Field Values

KEY_NUM_CONFIGURABLE_KEYS

public static final String KEY_NUM_CONFIGURABLE_KEYS

See Also:

Constant Field Values

Constructor Detail

KeyboardLayoutCapability

public KeyboardLayoutCapability()

Constructs a new KeyboardLayoutCapability object

KeyboardLayoutCapability

public KeyboardLayoutCapability(Hashtable<String,Object> hash)

Constructs a new KeyboardLayoutCapability object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

KeyboardLayoutCapability

public KeyboardLayoutCapability(@NonNull
                                KeyboardLayout keyboardLayout,
                                @NonNull
                                Integer numConfigurableKeys)

Constructs a new KeyboardLayoutCapability object

Parameters:

keyboardLayout -

numConfigurableKeys - Number of keys available for special characters, App can customize as per their needs. {"num_max_value": 10, "num_min_value": 0}

Method Detail

setKeyboardLayout

public KeyboardLayoutCapability setKeyboardLayout(@NonNull
                                                  KeyboardLayout keyboardLayout)

Sets the keyboardLayout.

Parameters:

keyboardLayout -

getKeyboardLayout

public KeyboardLayout getKeyboardLayout()

Gets the keyboardLayout.

Returns:

KeyboardLayout

setNumConfigurableKeys

public KeyboardLayoutCapability setNumConfigurableKeys(@NonNull
                                                       Integer numConfigurableKeys)

Sets the numConfigurableKeys.

Parameters:

numConfigurableKeys - Number of keys available for special characters, App can customize as per their needs. {"num_max_value": 10, "num_min_value": 0}

getNumConfigurableKeys

public Integer getNumConfigurableKeys()

Gets the numConfigurableKeys.

Returns:

Integer Number of keys available for special characters, App can customize as per their needs. {"num_max_value": 10, "num_min_value": 0}