Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class KeyboardProperties

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

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 keypresses 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.

Fields

KEY_KEYPRESS_MODE

public static final java.lang.String KEY_KEYPRESS_MODE
Constant Value
"keypressMode"

KEY_KEYBOARD_LAYOUT

public static final java.lang.String KEY_KEYBOARD_LAYOUT
Constant Value
"keyboardLayout"

KEY_LIMITED_CHARACTER_LIST

public static final java.lang.String KEY_LIMITED_CHARACTER_LIST
Constant Value
"limitedCharacterList"

KEY_AUTO_COMPLETE_TEXT

public static final java.lang.String KEY_AUTO_COMPLETE_TEXT
Constant Value
"autoCompleteText"

KEY_LANGUAGE

public static final java.lang.String KEY_LANGUAGE
Constant Value
"language"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

KeyboardProperties()

public KeyboardProperties()

KeyboardProperties( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

public KeyboardProperties(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash

Methods

getLanguage()

public com.smartdevicelink.proxy.rpc.enums.Language getLanguage()

setLanguage( Language language )

public void setLanguage(Language language)

Parameters

language

getKeyboardLayout()

public com.smartdevicelink.proxy.rpc.enums.KeyboardLayout getKeyboardLayout()

setKeyboardLayout( KeyboardLayout keyboardLayout )

public void setKeyboardLayout(KeyboardLayout keyboardLayout)

Parameters

keyboardLayout

getKeypressMode()

public com.smartdevicelink.proxy.rpc.enums.KeypressMode getKeypressMode()

setKeypressMode( KeypressMode keypressMode )

public void setKeypressMode(KeypressMode keypressMode)

Parameters

keypressMode

getLimitedCharacterList()

public java.util.List getLimitedCharacterList()

setLimitedCharacterList( java.util.List<java.lang.String> limitedCharacterList )

public void setLimitedCharacterList(java.util.List<java.lang.String> limitedCharacterList)

Parameters

limitedCharacterList

getAutoCompleteText()

public java.lang.String getAutoCompleteText()

setAutoCompleteText( String autoCompleteText )

public void setAutoCompleteText(String autoCompleteText)

Parameters

autoCompleteText

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section