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
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
HMI Documentation
OnKeyboardInput

OnKeyboardInput

Type
Notification
Sender
HMI
Purpose
Inform SDL that a keyboard event has occurred.

Notification

Must

Notify SDL whether keyboard input characters are displayed as masked or not masked on HMI screen.

Note
  1. By default keyboard input characters are not masked.
  2. When maskInputCharacters value is set to "USER_CHOICE_INPUT_KEY_MASK", HMI masks input characters and provides a toggle button allowing the user to unmask them if needed.

Parameters

Name Type Mandatory Additional
event Common.KeyboardEvent true
data String false minlength: 0
maxlength: 500

Sequence Diagrams

JSON Message Examples

Example Notification

{
  "jsonrpc" : "2.0",
  "method" : "UI.OnKeyboardInput",
  "params" :
  {
    "event" : "ENTRY_CANCELLED"
  }
}
View on GitHub.com
Previous Section Next Section