• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.InputMethodSubtype (Input Method Subtype)
2<!--Kit: IME Kit-->
3<!--Subsystem: MiscServices-->
4<!--Owner: @illybyy-->
5<!--Designer: @andeszhang-->
6<!--Tester: @murphy1984-->
7<!--Adviser: @zhang_yixin13-->
8
9The **InputMethodSubtype** module provides APIs for managing the attributes of input method subtypes. The input method subtype allows the input method to switch to a specific mode or language, for example, the Chinese or English keyboard.
10
11> **NOTE**
12>
13>The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
14
15## Modules to Import
16
17```ts
18import { InputMethodSubtype } from '@kit.IMEKit';
19```
20
21## InputMethodSubtype
22
23Defines the attributes of input method subtypes.
24
25**System capability**: SystemCapability.MiscServices.InputMethodFramework
26
27| Name| Type| Read Only| Optional| Description|
28| -------- | -------- | -------- | -------- | -------- |
29| label | string | Yes| Yes| Optional. Label of the input method subtype.|
30| labelId<sup>10+</sup> | number | Yes| Yes| Optional. Label ID of the input method subtype.|
31| name | string | Yes| No| Mandatory. Bundle name of the application to which the input method subtype belongs.|
32| id | string | Yes| No| Mandatory. ID of the input method subtype.|
33| mode | 'upper' \| 'lower' | Yes| Yes| Optional. Mode of the input method subtype, including **upper** (uppercase) and **lower** (lowercase).|
34| locale | string | Yes| No| Mandatory. Locale of the input method subtype.|
35| language | string | Yes| No| Mandatory. Language of the input method subtype.|
36| icon | string | Yes| Yes| Optional. Icon of the input method subtype. It can be obtained by using **iconId**. This parameter is reserved.|
37| iconId | number | Yes| Yes| Optional. Icon ID of the input method subtype.|
38| extra | object | No| Yes| Mandatory. Extra information of the input method subtype.<br>**NOTE**<br>- This parameter is optional since API version 10.<br>- This parameter is reserved and currently has no specific meaning.|
39