• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.InputMethodExtensionContext (InputMethodExtensionContext)
2
3InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境，继承于ExtensionContext，提供InputMethodExtensionAbility具有的能力和接口，包括启动、停止、绑定、解绑Ability。
4
5> **说明：**
6>
7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8> 本模块接口仅可在Stage模型下使用。
9
10## 导入模块
11
12```ts
13import InputMethodExtensionContext from '@ohos.InputMethodExtensionContext';
14```
15
16## 使用说明
17
18在使用InputMethodExtensionContext的功能前，需要通过InputMethodExtensionAbility子类实例获取。
19
20```ts
21import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
22import Want from '@ohos.app.ability.Want';
23class InputMethodExtnAbility extends InputMethodExtensionAbility {
24  onCreate(want: Want): void {
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```ts
47import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
48import Want from '@ohos.app.ability.Want';
49import { BusinessError } from '@ohos.base';
50
51class InputMethodExtnAbility extends InputMethodExtensionAbility {
52  onCreate(want: Want): void {
53    let context = this.context;
54  }
55  onDestroy() {
56    this.context.destroy((err: BusinessError) => {
57      if(err) {
58        console.log(`Failed to destroy context, err code = ${err.code}`);
59        return;
60      }
61      console.log('Succeeded in destroying context.');
62    });
63  }
64}
65```
66
67## InputMethodExtensionContext.destroy
68
69destroy(): Promise\<void>;
70
71销毁输入法应用。使用Promise异步回调。
72
73**系统能力：** SystemCapability.MiscServices.InputMethodFramework
74
75**返回值：**
76
77| 类型 | 说明 |
78| -------- | -------- |
79| Promise\<void> | 无返回结果的Promise对象。 |
80
81**示例：**
82
83```ts
84import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
85import Want from '@ohos.app.ability.Want';
86import { BusinessError } from '@ohos.base';
87
88class InputMethodExtnAbility extends InputMethodExtensionAbility {
89  onCreate(want: Want): void {
90    let context = this.context;
91  }
92  onDestroy() {
93    this.context.destroy().then(() => {
94      console.log('Succeed in destroying context.');
95    }).catch((err: BusinessError)=>{
96      console.log(`Failed to destroy context, err code = ${err.code}`);
97    });
98  }
99}
100```