• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# IME Tool
2<!--Kit: IME Kit-->
3<!--Subsystem: MiscServices-->
4<!--Owner: @illybyy-->
5<!--Designer: @andeszhang-->
6<!--Tester: @murphy1984-->
7<!--Adviser: @zhang_yixin13-->
8
9**How to Use**<br>
10
11hdc shell ime [option] [parameter]
12
13**Commands**
14| Option| Parameter      | Description                                                        |
15| ---- | ---------- | ------------------------------------------------------------ |
16| -e | bundle [-b /-f] | Enables an input method as a specified mode. If **-b** or **-f** is not set, **-b** defaults to the basic mode, and **-f** defaults to the full mode.<br>**NOTE**<br>The enabling status of the preset default input method cannot be changed.|
17| -d | bundle | Disables a specified input method.<br>**NOTE**<br>The preset default input method cannot be disabled.|
18| -s   | bundle     | Switches to a specified input method.<br>**NOTE**<br>You are not allowed to switch to another input method when the screen is locked or the password is being entered.|
19| -g   | NA         | Obtains the current input method.|
20| -l   | NA         | Lists all input methods.|
21| -h   | NA         | Displays the help information.|
22
23## Managing Input Methods Using IME Tool
24
251. Enabling an input method. You can enable a third-party input method as basic mode or full mode.
26
27   ```shell
28    # Input: Use an hdc command to enable an input method.
29    # Processing: Check if it is an hdc shell command, and call the corresponding API for enabling.
30    # Output: The effect is equivalent to a direct API call.
31    # Basic mode
32    hdc shell ime -e com.xxx.yyy
33    # Full mode
34    hdc shell ime -e com.xxx.yyy -f
35   ```
36
372. Disabling an input method. You can disable a third-party input method.
38
39   ```shell
40    # Input: Use an hdc command to disable an input method.
41    # Processing: Check if it is an hdc shell command, and call the corresponding API for disabling.
42    # Output: The effect is equivalent to a direct API call.
43    hdc shell ime -d com.xxx.yyy
44   ```
45
463. Switching to a specified input method.
47
48   ```shell
49    # Input: Use an hdc command to switch the input method.
50    # Processing: Check if it is an hdc shell command, and call the corresponding API for switching.
51    # Output: The effect is equivalent to a direct API call.
52    hdc shell ime -s com.xxx.yyy
53   ```
54
554. Obtaining the current input method.
56
57   ```shell
58    # Input: Use an hdc command to obtain the current input method.
59    # Processing: Check if it is an hdc shell command, and call the corresponding API for obtaining.
60    # Output: The effect is equivalent to a direct API call.
61    hdc shell ime -g
62   ```
63
645. Listing all input methods. The enabling status of the preset default input method is not displayed.
65
66   ```shell
67    # Input: Use an hdc command to list all input methods.
68    # Processing: Check if it is an hdc shell command, and call the corresponding API for listing.
69    # Output: The effect is equivalent to a direct API call.
70    hdc shell ime -l
71   ```
72
736. Displaying the help information.
74
75   ```shell
76    # Input: Use an hdc command to display the help information.
77    # Output: Display the help information.
78    hdc shell ime -h
79   ```
80