!10547 API资料补齐（错误码整改 + 输入法子类型）

Merge pull request !10547 from Hollokin/master

zh-cn/application-dev/reference/apis/Readme-CN.md

@@ -202,6 +202,7 @@
   - [@ohos.inputmethodengine (输入法服务)](js-apis-inputmethodengine.md)
   - [@ohos.inputmethodextensionability (InputMethodExtensionAbility)](js-apis-inputmethod-extension-ability.md)
   - [@ohos.inputmethodextensioncontext (InputMethodExtensionContext)](js-apis-inputmethod-extension-context.md)
+  - [@ohos.inputmethodsubtype(输入法子类型)](js-apis-inputmethod-subtype.md)
   - [@ohos.pasteboard (剪贴板)](js-apis-pasteboard.md)
   - [@ohos.screenLock (锁屏管理)](js-apis-screen-lock.md)
   - [@ohos.systemTime (系统时间、时区)](js-apis-system-time.md)

zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md

 # InputMethodExtensionAbility
 
-InputMethodExtensionAbility模块，提供生态输入法应用开发者通过InputMethodExtensionAbility、InputMethodExtensionContext接口创作输入法应用，并管理输入法应用生命周期。
+开发者可通过继承本模块开发自己的输入法应用并管理输入法应用生命周期。
 
 > **说明：**
-> 
-> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-> 本模块接口仅可在Stage模型下使用。
+>
+>本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
 
 ## 导入模块
 
@@ -15,7 +14,7 @@ import InputMethodExtensionAbility from '@ohos.inputmethodextensionability';
 
 ## 属性
 
-**系统能力**：SystemCapability.MiscServices.InputMethodFramework
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
 
 | 名称 | 参数类型 | 可读 | 可写 | 说明 |
 | -------- | -------- | -------- | -------- | -------- |
@@ -24,11 +23,11 @@ import InputMethodExtensionAbility from '@ohos.inputmethodextensionability';
 
 ## InputMethodExtensionAbility.onCreate()
 
-onCreate(want: Want): void;
+onCreate(want: Want): void
 
 Extension生命周期回调，在拉起Extension输入法应用时调用，执行初始化输入法应用操作。
 
-**系统能力**：SystemCapability.MiscServices.InputMethodFramework
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
 
 **参数：**
 
@@ -38,29 +37,29 @@ Extension生命周期回调，在拉起Extension输入法应用时调用，执
 
 **示例：**
 
-  ```js
-  class InputMethodExt extends InputMethodExtensionAbility {
+```js
+class InputMethodExt extends InputMethodExtensionAbility {
     onCreate(want) {
-      console.log('onCreate, want:' + want.abilityName);
+        console.log('onCreate, want:' + want.abilityName);
     }
-  }
-  ```
+}
+```
 
 
 ## InputMethodExtensionAbility.onDestroy()
 
-onDestroy(): void;
+onDestroy(): void
 
 Extension生命周期回调，在销毁输入法应用时回调，执行资源清理等操作。
 
-**系统能力**：SystemCapability.MiscServices.InputMethodFramework
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
 
 **示例：**
 
-  ```js
-  class InputMethodExt extends InputMethodExtensionAbility {
+```js
+class InputMethodExt extends InputMethodExtensionAbility {
     onDestroy() {
-      console.log('onDestroy');
+        console.log('onDestroy');
     }
-  }
-  ```
+}
+```

zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md

@@ -5,9 +5,8 @@ InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环
 InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能力和接口，包括启动、停止、绑定、解绑Ability。
 
 > **说明：**
-> 
-> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。  
-> 本模块接口仅可在Stage模型下使用。
+>
+>本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。  
 
 ## 导入模块
 
@@ -20,151 +19,56 @@ import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext';
 在使用InputMethodExtensionContext的功能前，需要通过InputMethodExtensionAbility子类实例获取。
 
 ```js
-  import InputMethodExtensionAbility from '@ohos.inputmethodextensionability';
-  class MainAbility extends InputMethodExtensionAbility {
-      onCreate() {
-          let context = this.context;
-      }
-  }
+import InputMethodExtensionAbility from '@ohos.inputmethodextensionability';
+class MainAbility extends InputMethodExtensionAbility {
+    onCreate() {
+        let context = this.context;
+    }
+}
 ```
 
-## InputMethodExtensionContext.startAbility
+## InputMethodExtensionContext.destroy
 
-startAbility(want: Want, callback: AsyncCallback<void>): void;
+destroy(callback: AsyncCallback\<void>): void
 
-启动Ability，包含一个Want类型参数。callback形式返回启动结果。
+停止输入法应用自身。使用callback异步回调。
 
-**系统能力**：SystemCapability.MiscServices.InputMethodFramework
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
 
 **参数：**
 
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| want | [Want](js-apis-application-Want.md)  | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
-| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 |
+| 参数名   | 类型                 | 必填 | 说明                                                         |
+| -------- | -------------------- | ---- | ------------------------------------------------------------ |
+| callback | AsyncCallback\<void> | 是   | 回调函数。当停止输入法应用自身成功时，err为undefined；否则为错误对象。 |
 
 **示例：**
 
-  ```js
-    let want = {
-        'bundleName': 'com.example.myapp',
-        'abilityName': 'MyAbility'
-    };
-    this.context.startAbility(want, (err) => {
-        console.log('startAbility result:' + JSON.stringify(err));
-    });
-  ```
-
-## InputMethodExtensionContext.startAbility
-
-startAbility(want: Want, options?: StartOptions): Promise\<void>;
-
-启动Ability，包含Want类型参数，以及可选填的StartOption类型参数。通过Promise方法返回结果。
-
-**系统能力**：SystemCapability.MiscServices.InputMethodFramework
-
-**参数：**
-
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| want | [Want](js-apis-application-Want.md)  | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
-| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
-
-**返回值：**
-
-  | 类型 | 说明 | 
-  | -------- | -------- |
-  | Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 | 
-
-**示例：**
-
-  ```js
-    let want = {
-        'bundleName': 'com.example.myapp',
-        'abilityName': 'MyAbility'
-    };
-    this.context.startAbility(want).then((data) => {
-        console.log('success:' + JSON.stringify(data));
-    }).catch((error) => {
-        console.log('failed:' + JSON.stringify(error));
-    });
-
-  ```
-
-## InputMethodExtensionContext.startAbility
-
-startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void
-
-启动Ability，包含有两个参数，Want类型和StartOption类型参数。callback形式返回启动结果。
-
-**系统能力**：SystemCapability.MiscServices.InputMethodFramework
-
-**参数：**
-
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| want | [Want](js-apis-application-Want.md)  | 是 | 启动Ability的want信息。 |
-| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 |
-| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 |
-
-**示例：**
-
-  ```js
-  var want = {
-  	'deviceId': '',
-  	'bundleName': 'com.extreme.test',
-  	'abilityName': 'MainAbility'
-  };
-  var options = {
-  	windowMode: 0,
-  };
-  this.context.startAbility(want, options, (error) => {
-      console.log('error.code = ' + error.code)
-  })
-  ```
-
-## InputMethodExtensionContext.terminateSelf
-
-terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
-
-停止输入法应用自身，通过Callback方法返回接口调用是否成功。
-
-**系统能力**：SystemCapability.MiscServices.InputMethodFramework
-
-**参数：**
-
-| 参数名   | 类型                      | 必填 | 说明                                   |
-| -------- | ------------------------- | ---- | -------------------------------------- |
-| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数，返回接口调用是否成功的结果。 |
-
-**示例：**
-
-  ```js
-this.context.terminateSelf((err) => {
-    console.log('terminateSelf result:' + JSON.stringify(err));
+```js
+this.context.destroy((err) => {
+    console.log('destroy result:' + JSON.stringify(err));
 });
-  ```
+```
 
-## InputMethodExtensionContext.terminateSelf
+## InputMethodExtensionContext.destroy
 
-terminateSelf(): Promise&lt;void&gt;;
+destroy(): Promise<void&gt;
 
-停止输入法应用自身。通过Promise返回结果。
+停止输入法应用自身。通过Promise异步回调。
 
-**系统能力**：SystemCapability.MiscServices.InputMethodFramework
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
 
 **返回值：**
 
-  | 类型 | 说明 | 
-  | -------- | -------- |
-  | Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 | 
+| 类型 | 说明 |
+| -------- | -------- |
+| Promise<void&gt; | 无返回结果的Promise对象。 |
 
 **示例：**
 
-  ```js
-  this.context.terminateSelf().then((data) => {
-      console.log('success:' + JSON.stringify(data));
-  }).catch((error) => {
-      console.log('failed:' + JSON.stringify(error));
-  });
-  ```
+```js
+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

zh-cn/application-dev/reference/apis/js-apis-inputmethod-subtype.md

+# 输入法子类型
+
+本模块提供对输入法子类型的属性管理。
+
+> **说明：**
+>
+>本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+## 导入模块
+
+```
+import inputMethodEngine from '@ohos.inputMethodSubtype';
+```
+
+## 属性
+
+属性值。
+
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
+
+| 名称 | 参数类型 | 可读 | 可写 | 必选 | 说明 |
+| -------- | -------- | -------- | -------- | -------- | -------- |
+| label | string | 是 | 否 | 否 | 输入法子类型的标签。 |
+| name | string | 是 | 否 | 是 | 输入法子类型的名字。 |
+| id | string | 是 | 否 | 是 | 输入法子类型的id。 |
+| mode | string | 是 | 否 | 否 | 输入法子类型的模式，包括upper（大写）和lower（小写）。 |
+| locale | string | 是 | 否 | 是 | 输入法子类型的方言版本。 |
+| language | string | 是 | 否 | 是 | 输入法子类型的语言。 |
+| icon | string | 是 | 否 | 否 | 输入法子类型的图标。 |
+| iconId | number | 是 | 否 | 否 | 输入法子类型的图标id。 |
+| extra | object | 是 | 是 | 是 | 输入法子类型的其他信息。 |
\ No newline at end of file

zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md

+# 输入法框架错误码
+
+## 12800001 包管理服务异常
+
+**错误信息**
+
+Package manager error.
+
+**错误描述**
+
+当依赖包管理接口来获取一些信息失败时，系统会报此错误码。
+
+**可能原因**
+
+在调用getInputMethods、listCurrentInputMethodSubtype等接口获取输入法及子类型的时候，由于获取包管理服务异常时会报错。
+
+**处理步骤**
+
+无
+
+## 12800002 输入法应用异常
+
+**错误信息**
+
+Input method engine error.
+
+**错误描述**
+
+用户调用输入法应用接口失败时，系统会报此错误码。
+
+**可能原因**
+
+在执行显示键盘、隐藏键盘等操作时，由于输入法应用进程死亡导致操作失败时会报错。
+
+**处理步骤**
+
+查看输入法应用进程是否正常。例如再次在普通应用（微信、联系人等第三方应用）中点击对话框看键盘能否被正常拉起。
+
+## 12800003 客户端应用异常
+
+**错误信息**
+
+Input method client error.
+
+**错误描述**
+
+当三方应用（微信、设置、联系人等）的对话框等编辑控件调用显示键盘、隐藏键盘失败时，系统会报此错误码。
+
+**可能原因**
+
+三方应用客户端服务异常导致输入法应用与三方应用客户端断链。
+
+**处理步骤**
+
+重新将输入法应用与三方应用进行绑定：将三方应用后台进程杀死，重新启动三方应用，通过点击对话框等方式触发输入法键盘的显示，若键盘正常显示，则问题解决。
+
+## 12800004 按键事件处理异常
+
+**错误信息**
+
+Key event processing error.
+
+**错误描述**
+
+当按键事件异常时，系统会报此错误码。
+
+**可能原因**
+
+按键事件分发、消费、监听异常时会报错。
+
+**处理步骤**
+
+无
+
+## 12800005 配置固化失败
+
+**错误信息**
+
+Configuration persisting error.
+
+**错误描述**
+
+当保存配置失败时，系统会报此错误码。
+
+**可能原因**
+
+当调用切换输入法接口的时候，会保存输入法的配置参数，系统参数配置模块异常导致参数保存失败时会报错。
+
+**处理步骤**
+
+执行hdc shell param get persist.sys.default_ime查看默认输入法参数，若可查看，则系统参数配置模块正常，可重启设备进行尝试。
+
+## 12800006 输入法控制器异常
+
+**错误信息**
+
+Input method controller error.
+
+**错误描述**
+
+当获取到输入法控制器失败时，系统会报此错误码。
+
+**可能原因**
+
+在调用getCotroller接口获取输入法控制器InputMethodController时发生异常时会报错。
+
+**处理步骤**
+
+无。
+
+## 12800007 输入法设置器异常
+
+**错误信息**
+
+Input method settings extension error.
+
+**错误描述**
+
+当获取到输入法设置器发生错误时，系统会报此错误码。
+
+**可能原因**
+
+在调用getSetting接口获取输入法设置器InputMethodSetting时发生异常时会报错。
+
+**处理步骤**
+
+无。
+
+## 12800008 输入法管理服务异常
+
+**错误信息**
+
+Input method manager service error.
+
+**错误描述**
+
+获取输入法管理服务异常时，系统会报此错误码。
+
+**可能原因**
+
+当调用[输入法框架](../apis/js-apis-inputmethod.md)中的任何接口都有可能由于依赖输入法管理服务，而服务找不到时发生此异常。
+
+**处理步骤**
+
+通过ps -A|grep inputmethod查看是否存在输入法服务的进程号，如果存在，则服务正常。
\ No newline at end of file