Update docs (16300)

Signed-off-by: N ester.zhou <ester.zhou@huawei.com>

Update docs (16300)
Signed-off-by: N ester.zhou <ester.zhou@huawei.com>
f3c6bd0c · ester.zhou · 31efd97d · f3c6bd0c · f3c6bd0c · f3c6bd0c
5 changed file
--- a/en/application-dev/reference/apis/js-apis-inputmethod-subtype.md
+++ b/en/application-dev/reference/apis/js-apis-inputmethod-subtype.md
@@ -14,16 +14,19 @@ import InputMethodSubtype from '@ohos.InputMethodSubtype';

 ## Attributes

- **System capability**: SystemCapability.MiscServices.InputMethodFramework
+ 
+
+**System capability**: SystemCapability.MiscServices.InputMethodFramework

 | Name| Type| Readable| Writable| Mandatory| Description|
 | -------- | -------- | -------- | -------- | -------- | -------- |
 | label | string | Yes| No| No| Label of the input method subtype.|
-| name | string | Yes| No| Yes| Name of the input method subtype.|
+| labelId<sup>10+</sup> | string | Yes| No| No| Label ID of the input method subtype.|
+| name | string | Yes| No| Yes| Bundle name of the input method.|
 | id | string | Yes| No| Yes| ID of the input method subtype.|
 | mode | string | Yes| No| No| Mode of the input method subtype, including **upper** (uppercase) and **lower** (lowercase).|
 | locale | string | Yes| No| Yes| Locale of the input method subtype.|
 | language | string | Yes| No| Yes| Language of the input method subtype.|
 | icon | string | Yes| No| No| Icon of the input method subtype.|
 | iconId | number | Yes| No| No| Icon ID of the input method subtype.|
-| extra | object | Yes| Yes| Yes| Extra information of the input method subtype.|
+| extra | object | Yes| Yes| No| Extra information of the input method subtype.<br>**NOTE**<br>This parameter is optional since API version 10.|
--- a/en/application-dev/reference/apis/js-apis-inputmethod.md
+++ b/en/application-dev/reference/apis/js-apis-inputmethod.md
 # @ohos.inputMethod (Input Method Framework)

-The **inputMethod** module provides an input method framework, which can be used to hide the keyboard, obtain the list of installed input methods, display the dialog box for input method selection, and more.
+The **inputMethod** module is oriented to common foreground applications (third-party applications and system applications such as Notes, Messaging, and Settings). It provides input method control and management capabilities, including displaying or hiding the soft keyboard, switching between input methods, and obtaining the list of all input methods.

 > **NOTE**
 >
@@ -33,10 +33,11 @@ Describes the input method application attributes.
 | -------- | -------- | -------- | -------- | -------- |
 | name<sup>9+</sup>  | string | Yes| No| Internal name of the input method. Mandatory.|
 | id<sup>9+</sup>    | string | Yes| No| Unique ID of the input method. Mandatory.|
-| label<sup>9+</sup>    | string | Yes| No| External display name of the input method. Optional.|
+| label<sup>9+</sup>    | string | Yes| No| External name of the input method. Optional.|
+| labelId<sup>10+</sup>    | string | Yes| No| External ID of the input method. Optional.|
 | icon<sup>9+</sup>    | string | Yes| No| Icon of the input method. Optional.|
 | iconId<sup>9+</sup>    | number | Yes| No| Icon ID of the input method. Optional.|
-| extra<sup>9+</sup>    | object | Yes| Yes| Extra information about the input method. Mandatory.|
+| extra<sup>9+</sup>    | object | Yes| Yes| Extra information about the input method. Optional.<br>**NOTE**<br>This parameter is optional since API version 10.|
 | packageName<sup>(deprecated)</sup> | string | Yes| No| Name of the input method package. Mandatory.<br>**NOTE**<br>This API is supported since API version 8 and deprecated since API version 9. You are advised to use **name**.|
 | methodId<sup>(deprecated)</sup> | string | Yes| No| Unique ID of the input method. Mandatory.<br>**NOTE**<br>This API is supported since API version 8 and deprecated since API version 9. You are advised to use **id**.|

@@ -231,7 +232,7 @@ switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallb

 Switches to another subtype of the current input method. This API uses an asynchronous callback to return the result.

-**Required permissions**: ohos.permission.CONNECT_IME_ABILITY (available only to system applications)
+**Required permissions**: ohos.permission.CONNECT_IME_ABILITY (available only to system applications) <br>**NOTE**<br>Since API version 10, this permission is not required if the caller is the current input method.

 **System capability**: SystemCapability.MiscServices.InputMethodFramework

@@ -239,7 +240,7 @@ Switches to another subtype of the current input method. This API uses an asynch

 | Name| Type| Mandatory| Description|
 | -------- | -------- | -------- | -------- |
-| target |  [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| Yes| Input method subtype to switch to.|
+| target |  [InputMethodSubtype](./js-apis-inputmethod-subtype.md)| Yes| Input method subtype to switch to.|
 | callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result. If the operation is successful, **err** is **undefined** and **data** is **true**. Otherwise, **err** is an error object.|

 **Error codes**
@@ -256,9 +257,9 @@ For details about the error codes, see [Input Method Framework Error Codes](../e
 ```js
 try {
    inputMethod.switchCurrentInputMethodSubtype({
-      id: "com.example.kikakeyboard",
-      label: "ServiceExtAbility",
-      name: "",
+      id: "ServiceExtAbility",
+      label: "",
+      name: "com.example.kikakeyboard",
      mode: "upper",
      locale: "",
      language: "",
@@ -287,7 +288,7 @@ switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise&lt;boolean&

 Switches to another subtype of the current input method. This API uses a promise to return the result.

-**Required permissions**: ohos.permission.CONNECT_IME_ABILITY (available only to system applications)
+**Required permissions**: ohos.permission.CONNECT_IME_ABILITY (available only to system applications) <br>**NOTE**<br>Since API version 10, this permission is not required if the caller is the current input method.

 **System capability**: SystemCapability.MiscServices.InputMethodFramework

@@ -295,7 +296,7 @@ Switches to another subtype of the current input method. This API uses a promise

 | Name| Type| Mandatory| Description|
 | -------- | -------- | -------- | -------- |
-|target |  [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| Yes| Input method subtype to switch to.|
+|target |  [InputMethodSubtype](./js-apis-inputmethod-subtype.md)| Yes| Input method subtype to switch to.|

 **Return value**

@@ -317,9 +318,9 @@ For details about the error codes, see [Input Method Framework Error Codes](../e
 ```js
 try {
    inputMethod.switchCurrentInputMethodSubtype({
-      id: "com.example.kikakeyboard",
-      label: "ServiceExtAbility",
-      name: "",
+      id: "ServiceExtAbility",
+      label: "",
+      name: "com.example.kikakeyboard",
      mode: "upper",
      locale: "",
      language: "",
@@ -352,7 +353,7 @@ Obtains the current input method subtype.

 | Type                                        | Description                    |
 | -------------------------------------------- | ------------------------ |
-| [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype) | Current input method subtype.|
+| [InputMethodSubtype](./js-apis-inputmethod-subtype.md) | Current input method subtype.|

 **Example**

@@ -375,7 +376,7 @@ Switches to a specified subtype of a specified input method. This API uses an as
 | Name| Type| Mandatory| Description|
 | -------- | -------- | -------- | -------- |
 |inputMethodProperty |  [InputMethodProperty](#inputmethodproperty8)| Yes| Input method to switch to.|
-|inputMethodSubtype |  [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| Yes| Input method subtype to switch to.|
+|inputMethodSubtype |  [InputMethodSubtype](./js-apis-inputmethod-subtype.md)| Yes| Input method subtype to switch to.|
 | callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result. If the operation is successful, **err** is **undefined** and **data** is **true**. Otherwise, **err** is an error object.|

 **Error codes**
@@ -391,25 +392,9 @@ For details about the error codes, see [Input Method Framework Error Codes](../e

 ```js
 let im = inputMethod.getCurrentInputMethod();
-let inputMethodProperty = {
-    packageName: im.packageName,
-    methodId: im.methodId,
-    name: im.packageName,
-    id: im.methodId,
-    extra: {}
-}
+let imSubType = inputMethod.getCurrentInputMethodSubtype();
 try {
-    inputMethod.switchCurrentInputMethodAndSubtype(inputMethodProperty, {
-      id: "com.example.kikakeyboard",
-      label: "ServiceExtAbility",
-      name: "",
-      mode: "upper",
-      locale: "",
-      language: "",
-      icon: "",
-      iconId: 0,
-      extra: {}
-    }, (err,result) => {
+    inputMethod.switchCurrentInputMethodAndSubtype(im, imSubType, (err,result) => {
        if (err !== undefined) {
            console.error('Failed to switchCurrentInputMethodAndSubtype: ' + JSON.stringify(err));
            return;
@@ -440,7 +425,7 @@ Switches to a specified subtype of a specified input method. This API uses a pro
 | Name| Type| Mandatory| Description|
 | -------- | -------- | -------- | -------- |
 |inputMethodProperty |  [InputMethodProperty](#inputmethodproperty8)| Yes| Input method to switch to.|
-|inputMethodSubtype |  [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| Yes| Input method subtype to switch to.|
+|inputMethodSubtype |  [InputMethodSubtype](./js-apis-inputmethod-subtype.md)| Yes| Input method subtype to switch to.|

 **Return value**

@@ -461,25 +446,9 @@ For details about the error codes, see [Input Method Framework Error Codes](../e

 ```js
 let im = inputMethod.getCurrentInputMethod();
-let inputMethodProperty = {
-    packageName: im.packageName,
-    methodId: im.methodId,
-    name: im.packageName,
-    id: im.methodId,
-    extra: {}
-}
+let imSubType = inputMethod.getCurrentInputMethodSubtype();
 try {
-    inputMethod.switchCurrentInputMethodAndSubtype(inputMethodProperty, {
-      id: im.packageName,
-      label: im.methodId,
-      name: "",
-      mode: "upper",
-      locale: "",
-      language: "",
-      icon: "",
-      iconId: 0,
-      extra: {}
-    }).then((result) => {
+    inputMethod.switchCurrentInputMethodAndSubtype(im, imSubType).then((result) => {
        if (result) {
            console.info('Succeeded in switching currentInputMethodAndSubtype.');
        } else {
@@ -886,7 +855,7 @@ inputMethodController.off('selectByRange');

 on(type: 'selectByMovement', callback: Callback&lt;Movement&gt;): void

-Enables listening for the selection-by-cursor-movement event. This API uses an asynchronous callback to return the result.
+Enables listening for the select-by-cursor-movement event. This API uses an asynchronous callback to return the result.

 **System capability**: SystemCapability.MiscServices.InputMethodFramework

@@ -894,7 +863,7 @@ Enables listening for the selection-by-cursor-movement event. This API uses an a

 | Name  | Type                                                        | Mandatory| Description                                                        |
 | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
-| type     | string                                                       | Yes  | Listening type.<br>The value **selectByMovement** indicates the selection-by-cursor-movement event.|
+| type     | string                                                       | Yes  | Listening type.<br>The value **selectByMovement** indicates the select-by-cursor-movement event.|
 | callback | Callback&lt;[Movement](./js-apis-inputmethod-InputMethodCommon.md#movement)&gt; | Yes  | Callback used to return the range of the text to be selected.<br>Your application needs to select the text in the returned range in the text box.|

 **Example**
@@ -909,7 +878,7 @@ inputMethodController.on('selectByMovement', (movement) => {

 off(type: 'selectByMovement'): void

-Disables listening for the selection-by-cursor-movement event.
+Disables listening for the select-by-cursor-movement event.

 **System capability**: SystemCapability.MiscServices.InputMethodFramework

@@ -917,7 +886,7 @@ Disables listening for the selection-by-cursor-movement event.

 | Name| Type  | Mandatory| Description                                                        |
 | ------ | ------ | ---- | ------------------------------------------------------------ |
-| type   | string | Yes  | Listening type.<br>The value **selectByMovement** indicates the selection-by-cursor-movement event.|
+| type   | string | Yes  | Listening type.<br>The value **selectByMovement** indicates the select-by-cursor-movement event.|

 **Example**

@@ -942,7 +911,7 @@ Enables listening for the input method and subtype change event. This API uses a
 | Name  | Type                           | Mandatory| Description                                                        |
 | -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
 | type     | string                        | Yes  | Listening type.<br>The value **'imeChange'** indicates the input method and subtype change event.|
-| callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)) => void  | Yes| Callback used to return the input method attributes and subtype.|
+| callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md)) => void  | Yes| Callback used to return the input method attributes and subtype.|

 **Example**

@@ -965,7 +934,7 @@ Disables listening for the input method and subtype change event. This API uses
 | Name  | Type                           | Mandatory| Description                                                        |
 | -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
 | type     | string                        | Yes  | Listening type.<br>The value **'imeChange'** indicates the input method and subtype change event.|
-| callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)) => void  | No| Callback used to return the input method attributes and subtype.|
+| callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md)) => void  | No| Callback used to return the input method attributes and subtype.|

 **Example**

@@ -986,7 +955,7 @@ Obtains all subtypes of a specified input method. This API uses an asynchronous
 | Name  | Type                                              | Mandatory| Description                  |
 | -------- | -------------------------------------------------- | ---- | ---------------------- |
 | inputMethodProperty | InputMethodProperty| Yes| Input method to which the subtypes belong.|
-| callback | AsyncCallback&lt;Array<[InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)>&gt; | Yes| Callback used to return all subtypes of the specified input method.|
+| callback | AsyncCallback&lt;Array<[InputMethodSubtype](./js-apis-inputmethod-subtype.md)>&gt; | Yes| Callback used to return all subtypes of the specified input method.|

 **Error codes**

@@ -1038,7 +1007,7 @@ Obtains all subtypes of a specified input method. This API uses a promise to ret

 | Type                                                       | Description                  |
 | ----------------------------------------------------------- | ---------------------- |
-| Promise<Array<[InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)>> | Promise used to return all subtypes of the specified input method.|
+| Promise<Array<[InputMethodSubtype](./js-apis-inputmethod-subtype.md)>> | Promise used to return all subtypes of the specified input method.|

 **Error codes**

@@ -1082,7 +1051,7 @@ Obtains all subtypes of this input method. This API uses an asynchronous callbac

 | Name  | Type                                              | Mandatory| Description                  |
 | -------- | -------------------------------------------------- | ---- | ---------------------- |
-| callback | AsyncCallback&lt;Array<[InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)>&gt; | Yes  | Callback used to return all subtypes of the current input method.|
+| callback | AsyncCallback&lt;Array<[InputMethodSubtype](./js-apis-inputmethod-subtype.md)>&gt; | Yes  | Callback used to return all subtypes of the current input method.|

 **Error codes**

@@ -1121,7 +1090,7 @@ Obtains all subtypes of this input method. This API uses a promise to return the

 | Type                                                       | Description                  |
 | ----------------------------------------------------------- | ---------------------- |
-| Promise<Array<[InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)>> | Promise used to return all subtypes of the current input method.|
+| Promise<Array<[InputMethodSubtype](./js-apis-inputmethod-subtype.md)>> | Promise used to return all subtypes of the current input method.|

 **Error codes**


--- a/en/application-dev/reference/apis/js-apis-inputmethodengine.md
+++ b/en/application-dev/reference/apis/js-apis-inputmethodengine.md
--- a/en/release-notes/changelogs/OpenHarmony_3.2.10.12/changelog-imf.md
+++ b/en/release-notes/changelogs/OpenHarmony_3.2.10.12/changelog-imf.md
+# Input Method Framework Subsystem – Input Method Framework Service Changelog
+
+
+## @ohos.InputMethodSubtype Change of name, label, and id
+Changed the **name**, **label**, and **id** attributes since API version 9.
+
+**Change Impact**
+
+Applications must be adapted to the following changes.
+
+| Name| Before Change| After Change|
+| -------- | -------- | -------- |
+| label | (1) Value: ID of the input method subtype.| (1) Value: Label of the input method subtype.|
+| name | (1) Description: Name of the input method subtype. (2) Value: Label of the input method subtype.| (1) Description: Bundle name of the input method; (2) Value: Bundle name of the input method.|
+| id | (1) Value: Bundle name of the input method.| (1) Value: ID of the input method subtype.|
+
+**Adaptation Guide**
+
+Update the code to adapt to the preceding changes.
--- a/en/release-notes/changelogs/OpenHarmony_4.0.5.3/changelog-imf.md
+++ b/en/release-notes/changelogs/OpenHarmony_4.0.5.3/changelog-imf.md
+# Input Method Framework Subsystem – Input Method Framework Service Changelog
+
+
+## @ohos.InputMethodSubtype Change of name, label, and id
+Changed the **name**, **label**, and **id** attributes since API version 9.
+
+**Change Impact**
+
+Applications must be adapted to the following changes.
+
+| Name| Before Change| After Change|
+| -------- | -------- | -------- |
+| label | (1) Value: ID of the input method subtype.| (1) Value: Label of the input method subtype.|
+| name | (1) Description: Name of the input method subtype. (2) Value: Label of the input method subtype.| (1) Description: Bundle name of the input method; (2) Value: Bundle name of the input method.|
+| id | (1) Value: Bundle name of the input method.| (1) Value: ID of the input method subtype.|
+
+**Adaptation Guide**
+
+Update the code to adapt to the preceding changes.