輸入法框架

說明： 本模塊首批接口從API version 6開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。 開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導入模塊

import inputMethod from '@ohos.inputMethod';

inputMethod8+

常量值。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Miscservices.InputMethodFramework

InputMethodProperty8+

輸入法應用屬性。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Miscservices.InputMethodFramework

inputMethod.getInputMethodController

getInputMethodController(): InputMethodController

獲取客戶端實例[InputMethodController]。

系統能力 ：SystemCapability.Miscservices.InputMethodFramework

返回值：

| 類型 | 說明 |
| -------- | -------- |
| [InputMethodController](#InputMethodController) | 回調返回當前客戶端實例。 |

示例：

var InputMethodController = inputMethod.getInputMethodController();

inputMethod.getInputMethodSetting8+

getInputMethodSetting(): InputMethodSetting

獲取客戶端設置實例[InputMethodSetting]。

系統能力 ： SystemCapability.Miscservices.InputMethodFramework

返回值：

示例：

var InputMethodSetting = inputMethod.getInputMethodSetting();

InputMethodController

下列API示例中都需使用[getInputMethodController]回調獲取到InputMethodController實例，再通過此實例調用對應方法。

stopInput

stopInput(callback: AsyncCallback): void

隱藏輸入法。

系統能力 ：SystemCapability.Miscservices.InputMethodFramework

參數：

示例：

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

stopInput

stopInput(): Promise

隱藏輸入法。

系統能力 ： SystemCapability.Miscservices.InputMethodFramework

返回值：

示例：

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

InputMethodSetting8+

下列API示例中都需使用[getInputMethodSetting]回調獲取到InputMethodSetting實例，再通過此實例調用對應方法。

listInputMethod

listInputMethod(callback: AsyncCallback>): 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);
    }
 });

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);
   }

displayOptionalInputMethod

displayOptionalInputMethod(callback: AsyncCallback): void

顯示輸入法選擇對話框。

系統能力 ： SystemCapability.Miscservices.InputMethodFramework

參數：

示例：

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

displayOptionalInputMethod

displayOptionalInputMethod(): Promise

顯示輸入法選擇對話框。

系統能力 ： SystemCapability.Miscservices.InputMethodFramework

返回值：

示例：

InputMethodSetting.displayOptionalInputMethod();

審核編輯 黃宇