鸿蒙开发系统基础能力：【@ohos.inputMethod (输入法框架)】

输入法框架

 说明：  本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import inputMethod from '@ohos.inputMethod';
1

inputMethod8+

常量值。

系统能力：以下各项对应的系统能力均为SystemCapability.Miscservices.InputMethodFramework

InputMethodProperty8+

输入法应用属性。

系统能力：以下各项对应的系统能力均为SystemCapability.Miscservices.InputMethodFramework

inputMethod.getInputMethodController

getInputMethodController(): InputMethodController

获取客户端实例[InputMethodController]。

系统能力：SystemCapability.Miscservices.InputMethodFramework

返回值：

| 类型 | 说明 |
| -------- | -------- |
| [InputMethodController](#InputMethodController) | 回调返回当前客户端实例。 |
1
2
3

示例：

  var InputMethodController = inputMethod.getInputMethodController();
1

inputMethod.getInputMethodSetting8+

getInputMethodSetting(): InputMethodSetting

获取客户端设置实例[InputMethodSetting]。

系统能力： SystemCapability.Miscservices.InputMethodFramework

返回值：

示例：

  var InputMethodSetting = inputMethod.getInputMethodSetting();
1

InputMethodController

下列API示例中都需使用[getInputMethodController]回调获取到InputMethodController实例，再通过此实例调用对应方法。

stopInput

stopInput(callback: AsyncCallback): void

隐藏输入法。

系统能力：SystemCapability.Miscservices.InputMethodFramework

参数：

示例：

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

stopInput

stopInput(): Promise

隐藏输入法。

系统能力： SystemCapability.Miscservices.InputMethodFramework

返回值：

示例：

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

InputMethodSetting8+

下列API示例中都需使用[getInputMethodSetting]回调获取到InputMethodSetting实例，再通过此实例调用对应方法。

listInputMethod

listInputMethod(callback: AsyncCallback<Array>): void

查询已安装的输入法列表。

系统能力： SystemCapability.Miscservices.InputMethodFramework

参数：

示例：

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

listInputMethod

listInputMethod(): Array

查询已安装的输入法列表。

系统能力： SystemCapability.Miscservices.InputMethodFramework

返回值：

示例：

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

displayOptionalInputMethod

displayOptionalInputMethod(callback: AsyncCallback): void

显示输入法选择对话框。

系统能力： SystemCapability.Miscservices.InputMethodFramework

参数：

示例：

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

displayOptionalInputMethod

displayOptionalInputMethod(): Promise

显示输入法选择对话框。

系统能力： SystemCapability.Miscservices.InputMethodFramework

返回值：

示例：

  InputMethodSetting.displayOptionalInputMethod();
1