com.smartdevicelink.proxy.rpc

Class OnKeyboardInput

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnKeyboardInput

All Implemented Interfaces:

Cloneable

public class OnKeyboardInput
extends RPCNotification

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DATA
static String	KEY_EVENT

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
OnKeyboardInput() Constructs a new OnKeyboardInput object
OnKeyboardInput(Hashtable<String,Object> hash) Constructs a new OnKeyboardInput object indicated by the Hashtable parameter
OnKeyboardInput(KeyboardEvent event) Constructs a new OnKeyboardInput object

Method Summary

Modifier and Type	Method and Description
String	getData()
KeyboardEvent	getEvent()
OnKeyboardInput	setData(String data)
OnKeyboardInput	setEvent(KeyboardEvent event)
String	toString()

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY_DATA

public static final String KEY_DATA

See Also:

Constant Field Values

KEY_EVENT

public static final String KEY_EVENT

See Also:

Constant Field Values

Constructor Detail

OnKeyboardInput

public OnKeyboardInput()

Constructs a new OnKeyboardInput object

OnKeyboardInput

public OnKeyboardInput(Hashtable<String,Object> hash)

Constructs a new OnKeyboardInput object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

OnKeyboardInput

public OnKeyboardInput(@NonNull
                       KeyboardEvent event)

Constructs a new OnKeyboardInput object

Method Detail

getEvent

public KeyboardEvent getEvent()

setEvent

public OnKeyboardInput setEvent(@NonNull
                                KeyboardEvent event)

setData

public OnKeyboardInput setData(String data)

getData

public String getData()

toString

public String toString()

Overrides:

toString in class Object