Input Method Framework

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';

inputMethod6+

Provides the constants.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name Type Readable Writable Description
MAX_TYPE_NUM number Yes No Maximum number of supported input methods.

InputMethodProperty6+

Describes the input method application attributes.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name Type Readable Writable Description
packageName string Yes No Package name.
methodId string Yes No Ability name.

inputMethod.getInputMethodController

getInputMethodController(): InputMethodController

Obtains an InputMethodController instance.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type Description
InputMethodController Returns the current InputMethodController instance.

Example

  var InputMethodController = inputMethod.getInputMethodController();

inputMethod.getInputMethodSetting6+

getInputMethodSetting(): InputMethodSetting

Obtains an InputMethodSetting instance.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type Description
InputMethodSetting Returns the current InputMethodSetting instance.

Example

  var InputMethodSetting = inputMethod.getInputMethodSetting();

InputMethodController

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

stopInput

stopInput(callback: AsyncCallback<boolean>): void

Hides the keyboard. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name Type Mandatory Description
callback AsyncCallback<boolean> Yes Callback used to return whether the keyboard is successfully hidden.

Example

 InputMethodController.stopInput((error)=>{
     console.info('stopInput');
 });

stopInput

stopInput(): Promise<boolean>

Hides the keyboard. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type Description
Promise<boolean> Promise used to return whether the keyboard is successfully hidden.

Example

  var isSuccess = InputMethodController.stopInput();
  console.info('stopInput isSuccess = ' + isSuccess);

InputMethodSetting6+

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

listInputMethod

listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>): void

Obtains the list of installed input methods. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name Type Mandatory Description
callback Array<InputMethodProperty> Yes Callback used to return the list of installed input methods.

Example

  InputMethodSetting.listInputMethod((properties)=>{
    for (var i = 0;i < properties.length; i++) {
     var property = properties[i];
     console.info(property.packageName + "/" + property.methodId);
    }
  });

listInputMethod

listInputMethod(): Promise<Array<InputMethodProperty>>

Obtains the list of installed input methods. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type Description
Promise<Array<InputMethodProperty>> Promise used to return the list of installed input methods.

Example

  var properties = InputMethodSetting.listInputMethod();
  for (var i = 0;i < properties.length; i++) {
    var property = properties[i];
    console.info(property.packageName + "/" + property.methodId);
  }

displayOptionalInputMethod

displayOptionalInputMethod(callback: AsyncCallback<void>): void

Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

  • Parameters
Name Type Mandatory Description
callback AsyncCallback<void> Yes Callback used to return the execution result.

Example

  InputMethodSetting.displayOptionalInputMethod(()=>{
   console.info('displayOptionalInputMethod is called');
   });

displayOptionalInputMethod

displayOptionalInputMethod(): Promise<void>

Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type Description
Promise<void> Promise used to return the execution result.

Example

  InputMethodSetting.displayOptionalInputMethod();