spiegel-keyman/android/docs/engine/KMManager/getKeyboardInfo.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

1.7 KiB

title
KMManager.getKeyboardInfo()

Summary

The getKeyboardInfo() method returns information of the specified keyboard.

Syntax

KMManager.getKeyboardInfo(Context context, int index)

Parameters

context
The context.
index
0-based position of the keyboard in keyboards list.

Returns

Returns an information Keyboard type of the specified keyboard.

Description

Use this method to get details of the keyboard at given position in keyboards list. Details include keyboard ID, language ID, keyboard name, language name and fonts.

Examples

Example: Using getKeyboardInfo()

The following script illustrate the use of getKeyboardInfo():

    Keyboard keyboardInfo = KMManager.getKeyboardInfo(this, 1);
    if (keyboardInfo != null) {
        String packageID = keyboardInfo.getPackageID();
        String keyboardId = keyboardInfo.getKeyboardID();
        String keyboardName = keyboardInfo.getKeyboardName();
        String languageId = keyboardInfo.getLanguageID();
        String languageName = keyboardInfo.getLanguageName();
        String version = keyboardInfo.getVersion();
        String font = keyboardInfo.getFont();
        String oskFont = keyboardInfo.getOSKFont();
        //
    }

History

Added syntax for returning Keyboard type in Keyman Engine for Android 14.0.

Deprecated syntax for returning the HashMap<String key, String value> in Keyman Engine for Android 14.0

See also