输入法框架API资料补充

Signed-off-by: N Hollokin <taoyuxin2@huawei.com>

输入法框架API资料补充
Signed-off-by: N Hollokin <taoyuxin2@huawei.com>
31a35463 · Hollokin · 52dfe72a · 31a35463 · 31a35463 · 31a35463
4 changed file
--- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
@@ -164,9 +164,9 @@ terminateSelf(): Promise&lt;void&gt;;

 **返回值：**

-  | 类型 | 说明 | 
-  | -------- | -------- |
-  | Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 | 
+| 类型 | 说明 |
+| -------- | -------- |
+| Promise&lt;void&gt; | Promise对象，无返回结果的Promise对象。 |

 **示例：**

@@ -177,3 +177,53 @@ this.context.terminateSelf().then((data) => {
    console.log('failed:' + JSON.stringify(error));
 });
 ```
+
+## InputMethodExtensionContext.destroy<sup>9+</sup>
+
+destroy(callback: AsyncCallback<void>): void
+
+停止输入法应用自身。使用callback异步回调。
+
+**模型约束**： 此接口仅可在Stage模型下使用。
+
+**系统能力**：SystemCapability.MiscServices.InputMethodFramework
+
+**参数：**
+
+| 参数名   | 类型                      | 必填 | 说明                                   |
+| -------- | ------------------------- | ---- | -------------------------------------- |
+| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。当启动Ability成功，err为undefined；否则为错误对象。 |
+
+**示例：**
+
+```ts
+this.context.destroy((err) => {
+    console.log('destroy result:' + JSON.stringify(err));
+});
+```
+
+## InputMethodExtensionContext.destroy<sup>9+</sup>
+
+destroy(): Promise&lt;void&gt;;
+
+停止输入法应用自身。通过Promise返回结果。
+
+**模型约束**： 此接口仅可在Stage模型下使用。
+
+**系统能力**：SystemCapability.MiscServices.InputMethodFramework
+
+**返回值：**
+
+| 类型 | 说明 |
+| -------- | -------- |
+| Promise&lt;void&gt; | Promise对象，无返回结果的Promise对象。 |
+
+**示例：**
+
+```ts
+this.context.destroy().then((data) => {
+    console.log('success:' + JSON.stringify(data));
+}).catch((error) => {
+    console.log('failed:' + JSON.stringify(error));
+});
+```
\ No newline at end of file
--- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
@@ -22,18 +22,18 @@ import inputMethod from '@ohos.inputmethod';
 | 名称 | 参数类型 | 可读 | 可写 | 说明 |
 | -------- | -------- | -------- | -------- | -------- |
 | MAX_TYPE_NUM | number | 是 | 否 | 可支持的最大输入法个数。 |
-| EXCEPTION_PERMISSION | number | 是 | 否 | 错误码。详见../errorcodes/errcode-inputmethod-framework.md，下同 |
-| EXCEPTION_PARAMCHECK | number | 是 | 否 | 错误码。 |
-| EXCEPTION_UNSUPPORTED | number | 是 | 否 | 错误码。 |
-| EXCEPTION_PACKAGEMANAGER | number | 是 | 否 | 错误码。 |
-| EXCEPTION_IMENGINE | number | 是 | 否 | 错误码。 |
-| EXCEPTION_IMCLIENT | number | 是 | 否 | 错误码。 |
-| EXCEPTION_KEYEVENT | number | 是 | 否 | 错误码。 |
-| EXCEPTION_CONFPERSIST | number | 是 | 否 | 错误码。 |
-| EXCEPTION_CONTROLLER | number | 是 | 否 | 错误码。 |
-| EXCEPTION_SETTINGS | number | 是 | 否 | 错误码。 |
-| EXCEPTION_IMMS | number | 是 | 否 | 错误码。 |
-| EXCEPTION_OTHERS | number | 是 | 否 | 错误码。 |
+| EXCEPTION_PERMISSION<sup>9+</sup> | number | 是 | 否 | 错误码。详见../errorcodes/errcode-inputmethod-framework.md，下同 |
+| EXCEPTION_PARAMCHECK<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_UNSUPPORTED<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_PACKAGEMANAGER<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_IMENGINE<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_IMCLIENT<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_KEYEVENT<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_CONFPERSIST<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_CONTROLLER<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_SETTINGS<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_IMMS<sup>9+</sup> | number | 是 | 否 | 错误码。 |
+| EXCEPTION_OTHERS<sup>9+</sup> | number | 是 | 否 | 错误码。 |

 ## InputMethodProperty<sup>8+</sup>

@@ -258,6 +258,12 @@ switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise&lt;boolean&
 | -------- | -------- | -------- | -------- |
 |target |  [InputMethodSubtype](./js-apis-inputmethodsubtype.md#inputmethodsubtype)| 是 | 传入要切换的目标输入法子类型。 |

+**返回值：**
+
+| 类型                                      | 说明                         |
+| ----------------------------------------- | ---------------------------- |
+| Promise\<boolean> | Promise对象。返回true表示在当前输入法应用内切换子类型成功；返回false表示在当前输入法应用内切换子类型失败。 |
+
 **示例：**

 ```ts
@@ -354,7 +360,7 @@ try {

 switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype, ): Promise&lt;boolean&gt;

-切换至指定输入法应用的指定子类型，用于跨输入法应用切换子类型。参数个数为1，否则抛出异常。
+切换至指定输入法应用的指定子类型，用于跨输入法应用切换子类型。使用promise异步回调。

 **模型约束**： 此接口仅可在Stage模型下使用。

@@ -369,6 +375,12 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp
 |inputMethodProperty |  [InputMethodProperty](#inputmethodproperty8)| 是 | 传入要切换的目标输入法。 |
 |inputMethodSubtype |  [InputMethodSubtype](./js-apis-inputmethodsubtype.md#inputmethodsubtype)| 是 | 传入要切换的目标输入法子类型。 |

+**返回值：**
+
+| 类型                                      | 说明                         |
+| ----------------------------------------- | ---------------------------- |
+| Promise\<boolean> | Promise对象。返回true表示切换至指定输入法应用的指定子类型成功；返回false表示切换至指定输入法应用的指定子类型失败。 |
+
 **示例：**

 ```ts
@@ -483,9 +495,9 @@ try {
 }
 ```

-### stopInputSession
+### stopInputSession<sup>9+</sup>

-stopInputSession(): Promise&lt;boolean&gt;<sup>9+</sup>
+stopInputSession(): Promise&lt;boolean&gt;

 隐藏输入法。使用promise异步回调。

@@ -962,7 +974,7 @@ showOptionalInputMethods(callback: AsyncCallback&lt;void&gt;): void

 | 参数名 | 类型 | 必填 | 说明 |
 | -------- | -------- | -------- | -------- |
-| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当输入法选择对话框显示成功。err为undefined，否则为错误对象。 |
+| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当输入法选择对话框显示成功，err为undefined，否则为错误对象。 |

 **示例：**


--- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
@@ -542,7 +542,7 @@ on(type: 'setSubtype', callback: (inputMethodSubtype: InputMethodSubtype) => voi
 | 参数名   | 类型   | 必填 | 说明                                                         |
 | -------- | ------ | ---- | ------------------------------------------------------------ |
 | type     | string | 是   | 设置监听类型。<br/>-&nbsp;type为'setSubtype'，表示订阅输入法子类型设置。<br/>-&nbsp;type为'keyboardHide'，表示订阅输入法隐藏。 |
-| callback | InputMethodSubtype   | 是   | 回调函数，，返回调用方的输入法子类型。                                                   |
+| callback | InputMethodSubtype   | 是   | 回调函数，返回调用方的输入法子类型。                                                   |

 **示例：**

@@ -554,7 +554,7 @@ inputMethodEngine.getInputMethodAbility().on('setSubtype', (inputMethodSubtype)

 ### off('setSubtype')<sup>9+</sup>

-off(type: 'setSubtype', callback?: () => void): void
+off(ype: 'setSubtype', callback?: (inputMethodSubtype: InputMethodSubtype) => void): void

 取消订阅输入法子类型事件。使用callback异步回调。

@@ -565,7 +565,7 @@ off(type: 'setSubtype', callback?: () => void): void
 | 参数名   | 类型   | 必填 | 说明                                                         |
 | -------- | ------ | ---- | ------------------------------------------------------------ |
 | type     | string | 是   | 设置监听类型。<br/>-&nbsp;type为'setSubtype'，表示取消订阅输入法子类型设置。<br/>-&nbsp;type为'keyboardHide'，表示订阅输入法隐藏。 |
-| callback | InputMethodSubtype   | 是   | 回调函数，，返回调用方的输入法子类型。                                                   |
+| callback | InputMethodSubtype   | 是   | 回调函数，返回调用方的输入法子类型。                                                   |

 **示例：**

@@ -787,12 +787,67 @@ inputMethodEngine.getKeyboardDelegate().off('textChange', (text) => {

 下列API示例中都需使用[inputStart](#inputStart9)回调获取到KeyboardController实例，再通过此实例调用对应方法。

-### hideKeyboard
+###hide<sup>9+</sup>
+
+hide(callback: AsyncCallbackAsyncCallback&lt;void&gt;): void
+
+隐藏输入法。使用callback异步回调。
+
+**系统能力**： SystemCapability.MiscServices.InputMethodFramework
+
+**参数：**
+
+| 参数名   | 类型                   | 必填 | 说明     |
+| -------- | ---------------------- | ---- | -------- |
+| callback | AsyncCallback&lt;void> | 否   | 回调函数。当输入法隐藏成功，err为undefined，否则为错误对象 |
+
+**示例：**
+
+```js
+KeyboardController.hide((err) => {
+    if (err === undefined) {
+        console.error('hide err: ' + JSON.stringify(err));
+        return;
+    }
+    console.log('hide success.');
+});
+```
+
+### hide<sup>9+</sup>
+
+hide(): Promise&lt;void&gt;
+
+隐藏输入法。使用promise异步回调。
+
+**系统能力**： SystemCapability.MiscServices.InputMethodFramework
+
+**返回值：**
+
+| 类型             | 说明                      |
+| ---------------- | ------------------------- |
+| Promise&lt;void> | Promise对象。无返回结果的Promise对象。 |
+
+**示例：**
+
+```js
+async function InputMethodEngine() {
+    await KeyboardController.hide().then(() => {
+        console.info('hide success.');
+    }).catch((err) => {
+        console.info('hide err: ' + JSON.stringify(err));
+    });
+}
+```
+
+### hideKeyboard<sup>(deprecated)</sup>

 hideKeyboard(callback: AsyncCallback&lt;void&gt;): void

 隐藏输入法。使用callback异步回调。

+> **说明：**
+> 从API version 8开始支持，API version 9开始废弃, 建议使用[hide](#hide9)替代。
+
 **系统能力**： SystemCapability.MiscServices.InputMethodFramework

 **参数：**
@@ -813,12 +868,15 @@ KeyboardController.hideKeyboard((err) => {
 });
 ```

-### hideKeyboard
+### hideKeyboard<sup>(deprecated)</sup>

 hideKeyboard(): Promise&lt;void&gt;

 隐藏输入法。使用promise异步回调。

+> **说明：**
+> 从API version 8开始支持，API version 9开始废弃, 建议使用[hide](#hide9-1)替代。
+
 **系统能力**： SystemCapability.MiscServices.InputMethodFramework

 **返回值：**
@@ -1437,7 +1495,7 @@ getForward(length:number, callback: AsyncCallback&lt;string&gt;): void
 获取光标前固定长度的文本。使用callback异步回调。

 > **说明：** 
-> 从API version 8开始支持，API version 9开始废弃, 建议使用[getForward](#getforward9)替代
+> 从API version 8开始支持，API version 9开始废弃, 建议使用[getForward](#getforward9)替代。

 **系统能力**： SystemCapability.MiscServices.InputMethodFramework


--- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodsubtype.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodsubtype.md
@@ -6,6 +6,12 @@
 >
 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

+## 导入模块
+
+```
+import inputMethodEngine from '@ohos.inputMethodSubtype';
+```
+
 ## InputMethodSubtype

 属性值。