API object - Keyboard
The Keyboard
object contains the following members:
name
string
- Name of keyboard
id
string
- ID of the keyboard, always matches the filename of the keyboard.
filename
string
- Name of the keyboard .js file which should be combined with
options.keyboardBaseUri
. default
boolean
optionaltrue
if the keyboard is the recommended default for the language.false
if absent.rtl
boolean
optionaltrue
if the keyboard targets a right-to-left script.false
if absent.lastModified
string|number
- Date the keyboard was last updated.
fileSize
number
- Size of the keyboard file, in bytes.
version
string
- Version number of the keyboard.
languages
Array
optional- An array of
Language
objects linked to the keyboard. font
Object
optionalFont
object describing font for input fields (and OSK, ifoskFont
is not present). Only present when aKeyboard
object is a child of aLanguage
object.oskFont
Object
optionalFont
object describing font for the OSK. Only present when aKeyboard
object is a child of aLanguage
object.example
Object
optionalExample
object. Only present when aKeyboard
object is the child of aLanguage
object.desktopKeyboardID
number
optional- The numerical ID of the corresponding numerical ID for the desktop version of the keyboard.
devices
Object
optional- An object with the three properties
phone
,tablet
, anddesktop
. Each property holds a numerical value detailing the level of support specialized toward each class of device. Please refer to the Developer Keyboard Catalogue page for more details.
Example case
The following is extracted from https://api.keyman.com/cloud/4.0/keyboards/hebrew.
"keyboard": {
"id": "hebrew",
"name": "Hebrew",
"filename": "hebrew\/1.0\/hebrew-1.0.js",
"version": "1.0",
"lastModified": "2014-03-21T16:22:19+11:00",
"rtl": true,
"devices": {
"phone": 1,
"tablet": 1,
"desktop": 2
},
"languages": [
{
"id": "heb",
"name": "Hebrew",
"region": 3
}
]
}