spiegel-keyman/android/docs/engine/KMManager/getKeyboardsList.md
Eberhard Beilharz a93467a3a0
chore(android): remove doc for non-existing deprecated functions
Several functions got deprecated and replaced with a function with
same name and parameters but different return type. The original
function no longer exists. This change removes the documentation for
those no longer existing deprecated functions.

Also update the documentation for two deprecated functions to show what
should be used instead.

Build-bot: skip
Test-bot: skip
2026-07-14 18:23:38 +02:00

60 lines
1.3 KiB
Markdown

---
title: KMManager.getKeyboardsList()
---
## Summary
The **`getKeyboardsList()`** method returns the keyboards list.
## Syntax
``` javascript
KMManager.getKeyboardsList(Context context)
```
### Parameters
`context`
: The context.
### Returns
Returns keyboards list as `List<Keyboard>` if it exists, `null`
otherwise.
## Description
Use this method to get details of all keyboard's in keyboards menu.
------------------------------------------------------------------------
## Examples
### Example: Using `getKeyboardsList()`
The following script illustrate the use of `getKeyboardsList()`:
``` javascript
List<Keyboard> keyboardsList = KMManager.getKeyboardsList(this);
if ((keyboardsList != null) && keyboardsList.size() < 2) {
// Add another Keyboard
Keyboard kbd = new Keyboard(...);
KMManager.addKeyboard(kbd);
}
```
## History
Added syntax for returning list of Keyboard type in Keyman Engine for
Android 14.0.
Deprecated syntax for returning the list of HashMap&lt;String key,
String value&gt; in Keyman Engine for Android 14.0
## See also
- [`getCurrentKeyboardIndex()`](getCurrentKeyboardIndex)
- [`getCurrentKeyboardInfo()`](getCurrentKeyboardInfo)
- [`getKeyboardIndex()`](getKeyboardIndex)
- [`getKeyboardInfo()`](getKeyboardInfo)
- [`keyboardExists()`](keyboardExists)