Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
OnKeyboardInput

Class OnKeyboardInput

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

On-screen keyboard event. Can be full string or individual key presses depending on keyboard mode.

Parameter List

Name Type Description Reg. Notes Version
event KeyboardEvent On-screen keyboard input data. Y SmartDeviceLink 3.0
data String On-screen keyboard input data.For dynamic keypress events, this will be the current compounded string of entry text.For entry cancelled and entry aborted events, this data param will be omitted. Maxlength: 500 SmartDeviceLink 3.0

Fields

KEY_DATA

public static final java.lang.String KEY_DATA
Constant Value
"data"

KEY_EVENT

public static final java.lang.String KEY_EVENT
Constant Value
"event"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

OnKeyboardInput()

Constructs a new OnKeyboardInput object

public OnKeyboardInput()

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

Constructs a new OnKeyboardInput object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

OnKeyboardInput( KeyboardEvent event )

Constructs a new OnKeyboardInput object

public OnKeyboardInput(KeyboardEvent event)

Parameters

event

Methods

getEvent()

public com.smartdevicelink.proxy.rpc.enums.KeyboardEvent getEvent()

setEvent( KeyboardEvent event )

public com.smartdevicelink.proxy.rpc.OnKeyboardInput setEvent(KeyboardEvent event)

Parameters

event

setData( String data )

public com.smartdevicelink.proxy.rpc.OnKeyboardInput setData(String data)

Parameters

data

getData()

public java.lang.String getData()

toString()

public java.lang.String toString()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCMessage getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, 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