@ohos.inputMethod (Input Method Framework) (System API)

The inputMethod module is oriented to common foreground applications (third-party applications and system applications such as Notes, Messaging, and Settings). It provides input method control and management capabilities, including displaying or hiding the soft keyboard, switching between input methods, and obtaining the list of all input methods.

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import inputMethod from '@ohos.inputMethod';

inputMethod.switchInputMethod¹¹⁺

switchInputMethod(bundleName: string, subtypeId?: string): Promise<void>

Switches to another input method. This API uses a promise to return the result.

Required permissions: ohos.permission.CONNECT_IME_ABILITY

System capability: SystemCapability.MiscServices.InputMethodFramework

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see Input Method Framework Error Codes.

Example

import { BusinessError } from '@ohos.base';

let currentIme = inputMethod.getCurrentInputMethod();
try {
  inputMethod.switchInputMethod(currentIme.name).then(() => {
    console.log('Succeeded in switching inputmethod.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
  })
} catch (err) {
  console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
}
let currentImeSubType = inputMethod.getCurrentInputMethodSubtype();
try {
  inputMethod.switchInputMethod(currentIme.name, currentImeSubType.id).then(() => {
    console.log('Succeeded in switching inputmethod.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
  })
} catch (err) {
  console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
}

InputMethodSetting⁸⁺

In the following API examples, you must first use getSetting to obtain an InputMethodSetting instance, and then call the APIs using the obtained instance.

on('imeShow')¹⁰⁺

on(type: 'imeShow', callback: (info: Array<InputWindowInfo>) => void): void

Subscribes to the soft keyboard show event of the input method panel in the fixed state. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Example

try {
  inputMethodSetting.on('imeShow', (info: Array<inputMethod.InputWindowInfo>) => {
    console.info('Succeeded in subscribing imeShow event.');
  });
} catch(err) {
  console.error(`Failed to unsubscribing imeShow. err: ${JSON.stringify(err)}`);
}

on('imeHide')¹⁰⁺

on(type: 'imeHide', callback: (info: Array<InputWindowInfo>) => void): void

Subscribes to the soft keyboard hide event of the input method panel in the fixed state. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Example

try {
  inputMethodSetting.on('imeHide', (info: Array<inputMethod.InputWindowInfo>) => {
    console.info('Succeeded in subscribing imeHide event.');
  });
} catch(err) {
  console.error(`Failed to unsubscribing imeHide. err: ${JSON.stringify(err)}`);
}

off('imeShow')¹⁰⁺

off(type: 'imeShow', callback?: (info: Array<InputWindowInfo>) => void): void

Unsubscribes from the soft keyboard show event of the input method panel in the fixed state.

System API: This is a system API.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Example

try {
  inputMethodSetting.off('imeShow');
} catch(err) {
  console.error(`Failed to unsubscribing imeShow. err: ${JSON.stringify(err)}`);
}

off('imeHide')¹⁰⁺

off(type: 'imeHide', callback?: (info: Array<InputWindowInfo>) => void): void

Unsubscribes from the soft keyboard hide event of the input method panel in the fixed state.

System API: This is a system API.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Example

try {
  inputMethodSetting.off('imeHide');
} catch(err) {
  console.error(`Failed to unsubscribing imeHide. err: ${JSON.stringify(err)}`);
}

isPanelShown¹¹⁺

isPanelShown(panelInfo: PanelInfo): boolean

Checks whether the input method panel of a specified type is shown.

System API: This is a system API.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Return value

Error codes

For details about the error codes, see Input Method Framework Error Codes.

Example

import { PanelInfo, PanelType, PanelFlag } from '@ohos.inputMethod.Panel';

let info: PanelInfo = {
  type: PanelType.SOFT_KEYBOARD,
  flag: PanelFlag.FLAG_FIXED
}
try {
  let result = inputMethodSetting.isPanelShown(info);
  console.log('Succeeded in querying isPanelShown, result: ' + result);
} catch (err) {
  console.error(`Failed to query isPanelShown: ${JSON.stringify(err)}`);
}