KeyboardProperties (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.rpc.KeyboardProperties

All Implemented Interfaces:: Cloneable

public class KeyboardProperties
extends RPCStruct

This mode causes the interaction to immediately display a keyboard entry through the HMI.

Parameter List

Name	Type	Mandatory	Additional	Description
language	Language	false		The keyboard language.
keyboardLayout	KeyboardLayout	false		Desired keyboard layout.
sendDynamicEntry	Boolean	false		In this mode, all key presses will be sent as they occur. If disabled, entire string of text will be returned only once submitted by user.If omitted, this value will be set to FALSE.
keypressMode	KeypressMode	False		Desired keypress mode.If omitted, this value will be set to RESEND_CURRENT_ENTRY.
limitedCharacterList	String	false	Array = true maxLength = 1 minsize = 1 maxsize = 100	Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled.
autoCompleteText	String	false	maxlength = 1000	Allows an app to prepopulate the text field with a suggested or completed entry as the user types.
autoCompleteList	String	false	Array = true maxlength = 1000 minsize = 0 maxsize = 100	Allows an app to prepopulate the text field with a list of suggested or completed entry as the user types. Set to an empty array to remove the auto-complete list from the screen
maskInputCharacters	KeyboardInputMask	false	Since: SmartDeviceLink 7.1.0	Allows an app to mask entered characters on HMI
customKeys	List	false	, SmartDeviceLink 7.1.0	Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}

, SmartDeviceLink 3.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_AUTO_COMPLETE_LIST`
`static String`	`KEY_AUTO_COMPLETE_TEXT` Deprecated.
`static String`	`KEY_CUSTOM_KEYS`
`static String`	`KEY_KEYBOARD_LAYOUT`
`static String`	`KEY_KEYPRESS_MODE`
`static String`	`KEY_LANGUAGE`
`static String`	`KEY_LIMITED_CHARACTER_LIST`
`static String`	`KEY_MASK_INPUT_CHARACTERS`

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description

KeyboardProperties()

KeyboardProperties(Hashtable<String,Object> hash)

Constructors
Constructor and Description
`KeyboardProperties()`
`KeyboardProperties(Hashtable<String,Object> hash)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`List<String>`	`getAutoCompleteList()` Gets the list that allows an app to prepopulate the text field with a list of suggested or completed entries as the user types.
`String`	`getAutoCompleteText()` Deprecated.
`List<String>`	`getCustomKeys()` Gets the customKeys.
`KeyboardLayout`	`getKeyboardLayout()`
`KeypressMode`	`getKeypressMode()`
`Language`	`getLanguage()`
`List<String>`	`getLimitedCharacterList()`
`KeyboardInputMask`	`getMaskInputCharacters()` Gets the maskInputCharacters.
`KeyboardProperties`	`setAutoCompleteList(List<String> autoCompleteList)` Sets the lists that allows an app to prepopulate the text field with a list of suggested or completed entries as the user types.
`KeyboardProperties`	`setAutoCompleteText(String autoCompleteText)` Deprecated. use `setAutoCompleteList(List <String>)` instead
`KeyboardProperties`	`setCustomKeys(List<String> customKeys)` Sets the customKeys.
`KeyboardProperties`	`setKeyboardLayout(KeyboardLayout keyboardLayout)`
`KeyboardProperties`	`setKeypressMode(KeypressMode keypressMode)`
`KeyboardProperties`	`setLanguage(Language language)`
`KeyboardProperties`	`setLimitedCharacterList(List<String> limitedCharacterList)`
`KeyboardProperties`	`setMaskInputCharacters(KeyboardInputMask maskInputCharacters)` Sets the maskInputCharacters.

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_KEYPRESS_MODE
```
public static final String KEY_KEYPRESS_MODE
```
    See Also:
    
    Constant Field Values
  - KEY_KEYBOARD_LAYOUT
```
public static final String KEY_KEYBOARD_LAYOUT
```
    See Also:
    
    Constant Field Values
  - KEY_LIMITED_CHARACTER_LIST
```
public static final String KEY_LIMITED_CHARACTER_LIST
```
    See Also:
    
    Constant Field Values
  - KEY_AUTO_COMPLETE_TEXT
```
@Deprecated
public static final String KEY_AUTO_COMPLETE_TEXT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - KEY_AUTO_COMPLETE_LIST
```
public static final String KEY_AUTO_COMPLETE_LIST
```
    See Also:
    
    Constant Field Values
  - KEY_MASK_INPUT_CHARACTERS
```
public static final String KEY_MASK_INPUT_CHARACTERS
```
    See Also:
    
    Constant Field Values
  - KEY_CUSTOM_KEYS
```
public static final String KEY_CUSTOM_KEYS
```
    See Also:
    
    Constant Field Values
  - KEY_LANGUAGE
```
public static final String KEY_LANGUAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KeyboardProperties
```
public KeyboardProperties()
```
  - KeyboardProperties
```
public KeyboardProperties(Hashtable<String,Object> hash)
```
- Method Detail
  - getLanguage
```
public Language getLanguage()
```
  - setLanguage
```
public KeyboardProperties setLanguage(Language language)
```
  - getKeyboardLayout
```
public KeyboardLayout getKeyboardLayout()
```
  - setKeyboardLayout
```
public KeyboardProperties setKeyboardLayout(KeyboardLayout keyboardLayout)
```
  - getKeypressMode
```
public KeypressMode getKeypressMode()
```
  - setKeypressMode
```
public KeyboardProperties setKeypressMode(KeypressMode keypressMode)
```
  - getLimitedCharacterList
```
public List<String> getLimitedCharacterList()
```
  - setLimitedCharacterList
```
public KeyboardProperties setLimitedCharacterList(List<String> limitedCharacterList)
```
  - getAutoCompleteText
```
@Deprecated
public String getAutoCompleteText()
```
    Deprecated.
    
    Gets the text that allows an app to prepopulate the text field with a suggested entry as the user types
    
    Returns:
    
    String representing the suggestions text
  - setAutoCompleteText
```
@Deprecated
public KeyboardProperties setAutoCompleteText(String autoCompleteText)
```
    Deprecated. use setAutoCompleteList(List <String>) instead
    
    Sets the text that allows an app to prepopulate the text field with a suggested entry as the user types
    
    Parameters:
    
    autoCompleteText - String representing the suggestions text
  - getAutoCompleteList
```
public List<String> getAutoCompleteList()
```
    Gets the list that allows an app to prepopulate the text field with a list of suggested or completed entries as the user types.
    
    Returns:
    
    List representing the suggestions list
  - setAutoCompleteList
```
public KeyboardProperties setAutoCompleteList(List<String> autoCompleteList)
```
    Sets the lists that allows an app to prepopulate the text field with a list of suggested or completed entries as the user types. Set to an empty array to remove the auto-complete list from the screen
    
    Parameters:
    
    autoCompleteList - List representing the suggestions list
  - setMaskInputCharacters
```
public KeyboardProperties setMaskInputCharacters(KeyboardInputMask maskInputCharacters)
```
    Sets the maskInputCharacters.
    
    Parameters:
    
    maskInputCharacters - Allows an app to mask entered characters on HMI
    
    Since:
    
    SmartDeviceLink 7.1.0
  - getMaskInputCharacters
```
public KeyboardInputMask getMaskInputCharacters()
```
    Gets the maskInputCharacters.
    
    Returns:
    
    KeyboardInputMask Allows an app to mask entered characters on HMI
    
    Since:
    
    SmartDeviceLink 7.1.0
  - setCustomKeys
```
public KeyboardProperties setCustomKeys(List<String> customKeys)
```
    Sets the customKeys.
    
    Parameters:
    
    customKeys - Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - getCustomKeys
```
public List<String> getCustomKeys()
```
    Gets the customKeys.
    
    Returns:
    
    List Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
    
    Since:
    
    SmartDeviceLink 7.1.0

Class KeyboardProperties

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_KEYPRESS_MODE

KEY_KEYBOARD_LAYOUT

KEY_LIMITED_CHARACTER_LIST

KEY_AUTO_COMPLETE_TEXT

KEY_AUTO_COMPLETE_LIST

KEY_MASK_INPUT_CHARACTERS

KEY_CUSTOM_KEYS

KEY_LANGUAGE

Constructor Detail

KeyboardProperties

KeyboardProperties

Method Detail

getLanguage

setLanguage

getKeyboardLayout

setKeyboardLayout

getKeypressMode

setKeypressMode

getLimitedCharacterList

setLimitedCharacterList

getAutoCompleteText

setAutoCompleteText

getAutoCompleteList

setAutoCompleteList

setMaskInputCharacters

getMaskInputCharacters

setCustomKeys

getCustomKeys