js-apis-inputmethod.md 5.7 KB
Newer Older
Z
zhouyongfei 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
# 输入法框架

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

```
import inputMethod from '@ohos.inputMethod';
```

## inputMethod<sup>8+</sup>

常量值。

Z
refresh  
zhouyongfei 已提交
17
**系统能力**:以下各项对应的系统能力均为SystemCapability.Miscservices.InputMethodFramework
Z
刷新  
zhouyongfei 已提交
18

Z
zhouyongfei 已提交
19 20
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
刷新  
zhouyongfei 已提交
21
| MAX_TYPE_NUM | number | 是 | 否 | 可支持的最大输入法个数。 |
Z
zhouyongfei 已提交
22 23


24
## InputMethodProperty<sup>8+</sup>
Z
zhouyongfei 已提交
25 26 27

输入法应用属性。

Z
refresh  
zhouyongfei 已提交
28
**系统能力**:以下各项对应的系统能力均为SystemCapability.Miscservices.InputMethodFramework
Z
刷新  
zhouyongfei 已提交
29

Z
zhouyongfei 已提交
30 31
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
刷新  
zhouyongfei 已提交
32 33
| packageName | string | 是 | 否 | 包名。 |
| methodId | string | 是 | 否 | Ability名。 |
Z
zhouyongfei 已提交
34

35
## inputMethod.getInputMethodController
Z
zhouyongfei 已提交
36 37 38 39 40

getInputMethodController(): InputMethodController

获取客户端实例[InputMethodController](#InputMethodController)

Z
refresh  
zhouyongfei 已提交
41
**系统能力**:SystemCapability.Miscservices.InputMethodFramework
Z
zhouyongfei 已提交
42

43
**返回值:**
Z
zhouyongfei 已提交
44 45 46 47 48

    | 类型 | 说明 |
    | -------- | -------- |
    | [InputMethodController](#InputMethodController) | 回调返回当前客户端实例。 |

49
**示例:**
50
  ```js
Z
zhouyongfei 已提交
51 52
  var InputMethodController = inputMethod.getInputMethodController();
  ```
53

54
## inputMethod.getInputMethodSetting<sup>8+</sup>
Z
zhouyongfei 已提交
55 56 57 58 59

getInputMethodSetting(): InputMethodSetting

获取客户端设置实例[InputMethodSetting](#InputMethodSetting)

Z
refresh  
zhouyongfei 已提交
60
**系统能力**: SystemCapability.Miscservices.InputMethodFramework
Z
zhouyongfei 已提交
61

62
**返回值:**
Z
zhouyongfei 已提交
63 64 65 66 67 68

  | 类型                                      | 说明                         |
  | ----------------------------------------- | ---------------------------- |
  | [InputMethodSetting](#InputMethodSetting) | 回调返回当前客户端设置实例。 |


69
**示例:**
70
  ```js
Z
zhouyongfei 已提交
71 72 73
  var InputMethodSetting = inputMethod.getInputMethodSetting();
  ```

74
## InputMethodController
Z
zhouyongfei 已提交
75

Z
refresh  
zhouyongfei 已提交
76
下列API示例中都需使用[getInputMethodController](#getInputMethodController)回调获取到InputMethodController实例,再通过此实例调用对应方法。
Z
zhouyongfei 已提交
77 78 79 80 81 82 83

### stopInput

stopInput(callback: AsyncCallback&lt;boolean&gt;): void

隐藏输入法。

Z
refresh  
zhouyongfei 已提交
84
**系统能力**:SystemCapability.Miscservices.InputMethodFramework
Z
zhouyongfei 已提交
85

86
**参数:**
Z
zhouyongfei 已提交
87 88 89 90 91

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 返回输入法隐藏是否成功。 |

92
**示例:**
Z
zhouyongfei 已提交
93

94
```js
Z
zhouyongfei 已提交
95 96 97 98 99 100 101 102 103 104 105
 InputMethodController.stopInput((error)=>{
     console.info('stopInput');
 });
```

### stopInput

stopInput(): Promise&lt;boolean&gt;

隐藏输入法。

Z
refresh  
zhouyongfei 已提交
106
**系统能力**: SystemCapability.Miscservices.InputMethodFramework
Z
zhouyongfei 已提交
107

108
**返回值:**
Z
zhouyongfei 已提交
109

Z
refresh  
zhouyongfei 已提交
110 111 112
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise&lt;boolean&gt; | 返回输入法隐藏是否成功。 |
Z
zhouyongfei 已提交
113

114
**示例:**
Z
zhouyongfei 已提交
115 116


117
```js
Z
zhouyongfei 已提交
118 119 120 121
 var isSuccess = InputMethodController.stopInput();
 console.info('stopInput isSuccess = ' + isSuccess);
```

122
## InputMethodSetting<sup>8+</sup>
Z
zhouyongfei 已提交
123

Z
refresh  
zhouyongfei 已提交
124
下列API示例中都需使用[getInputMethodSetting](#getInputMethodSetting)回调获取到InputMethodSetting实例,再通过此实例调用对应方法。
Z
zhouyongfei 已提交
125

Z
refresh  
zhouyongfei 已提交
126
### listInputMethod
Z
zhouyongfei 已提交
127 128 129 130 131

listInputMethod(callback: AsyncCallback&lt;Array&lt;InputMethodProperty&gt;&gt;): void

查询已安装的输入法列表。

Z
refresh  
zhouyongfei 已提交
132
**系统能力**: SystemCapability.Miscservices.InputMethodFramework
Z
zhouyongfei 已提交
133

134
**参数:**
Z
refresh  
zhouyongfei 已提交
135 136 137
  | 参数名   | 类型                                               | 必填 | 说明                   |
  | -------- | -------------------------------------------------- | ---- | ---------------------- |
  | callback | Array<[InputMethodProperty](#InputMethodProperty)> | 是   | 返回已安装输入法列表。 |
Z
zhouyongfei 已提交
138

139
**示例:**
140
  ```js
Z
zhouyongfei 已提交
141
   InputMethodSetting.listInputMethod((properties)=>{
Z
zhouyongfei 已提交
142 143 144 145
     for (var i = 0;i < properties.length; i++) {
       var property = properties[i];
       console.info(property.packageName + "/" + property.methodId);
     }
Z
zhouyongfei 已提交
146 147 148
  });
  ```

Z
refresh  
zhouyongfei 已提交
149
### listInputMethod
Z
zhouyongfei 已提交
150

151
listInputMethod(): Array&lt;InputMethodProperty&gt;
Z
zhouyongfei 已提交
152 153 154

查询已安装的输入法列表。

Z
refresh  
zhouyongfei 已提交
155
**系统能力**: SystemCapability.Miscservices.InputMethodFramework
Z
zhouyongfei 已提交
156

157
**返回值:**
Z
refresh  
zhouyongfei 已提交
158 159 160
  | 类型                                                        | 说明                   |
  | ----------------------------------------------------------- | ---------------------- |
  | Promise<Array<[InputMethodProperty](#InputMethodProperty)>> | 返回已安装输入法列表。 |
Z
zhouyongfei 已提交
161

162
**示例:**
163
  ```js
Z
zhouyongfei 已提交
164 165 166
   var properties = InputMethodSetting.listInputMethod();
   for (var i = 0;i < properties.length; i++) {
     var property = properties[i];
Z
zhouyongfei 已提交
167
     console.info(property.packageName + "/" + property.methodId);
Z
zhouyongfei 已提交
168 169 170
   }
  ```

Z
refresh  
zhouyongfei 已提交
171
### displayOptionalInputMethod
Z
zhouyongfei 已提交
172 173 174 175 176

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

显示输入法选择对话框。

Z
refresh  
zhouyongfei 已提交
177
**系统能力**: SystemCapability.Miscservices.InputMethodFramework
Z
zhouyongfei 已提交
178

179
**参数:**
Z
zhouyongfei 已提交
180 181 182 183 184

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |

185
**示例:**
186
  ```js
Z
zhouyongfei 已提交
187 188 189 190 191
   InputMethodSetting.displayOptionalInputMethod(()=>{
     console.info('displayOptionalInputMethod is called');
   });
  ```

Z
refresh  
zhouyongfei 已提交
192
### displayOptionalInputMethod
Z
zhouyongfei 已提交
193 194 195 196 197

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

  显示输入法选择对话框。

Z
refresh  
zhouyongfei 已提交
198
  **系统能力**: SystemCapability.Miscservices.InputMethodFramework
Z
zhouyongfei 已提交
199

200
**返回值:**
Z
zhouyongfei 已提交
201

Z
refresh  
zhouyongfei 已提交
202
| 类型 | 说明 |
Z
zhouyongfei 已提交
203 204 205
| -------- | -------- |
| Promise&lt;void&gt; | 回调函数。 |

206
**示例:**
207
    ```js
Z
zhouyongfei 已提交
208 209
     InputMethodSetting.displayOptionalInputMethod();
    ```