• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.InputMethodExtensionContext (InputMethodExtensionContext)
2
3InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境,继承自ExtensionContext。
4
5InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能力和接口,包括启动、停止、绑定、解绑Ability。
6
7> **说明:**
8>
9> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
10
11## 导入模块
12
13```
14import InputMethodExtensionContext from '@ohos.InputMethodExtensionContext';
15```
16
17## 使用说明
18
19在使用InputMethodExtensionContext的功能前,需要通过InputMethodExtensionAbility子类实例获取。
20
21```js
22import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
23class MainAbility extends InputMethodExtensionAbility {
24    onCreate() {
25        let context = this.context;
26    }
27}
28```
29
30## InputMethodExtensionContext.destroy
31
32destroy(callback: AsyncCallback\<void>): void
33
34停止输入法应用自身。使用callback异步回调。
35
36**系统能力:** SystemCapability.MiscServices.InputMethodFramework
37
38**参数:**
39
40| 参数名   | 类型                 | 必填 | 说明                                                         |
41| -------- | -------------------- | ---- | ------------------------------------------------------------ |
42| callback | AsyncCallback\<void> | 是   | 回调函数。当停止输入法应用自身成功时,err为undefined;否则为错误对象。 |
43
44**示例:**
45
46```js
47this.context.destroy((err) => {
48    console.log('destroy result:' + JSON.stringify(err));
49});
50```
51
52## InputMethodExtensionContext.destroy
53
54destroy(): Promise\<void>;
55
56停止输入法应用自身。通过Promise异步回调。
57
58**系统能力:** SystemCapability.MiscServices.InputMethodFramework
59
60**返回值:**
61
62| 类型 | 说明 |
63| -------- | -------- |
64| Promise\<void>; | 无返回结果的Promise对象。 |
65
66**示例:**
67
68```js
69this.context.destroy().then(() => {
70    console.log('Succeeded in destoring context.');
71}).catch((error) => {
72    console.log('Failed to destory context: ' + JSON.stringify(error));
73});
74```
75