js-apis-inputmethod-extension-context.md 2.0 KB
Newer Older
H
update  
Hollokin 已提交
1
# @ohos.InputMethodExtensionContext (InputMethodExtensionContext)
Z
zhaolinglan 已提交
2

N
update  
ningning 已提交
3
InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境,继承于ExtensionContext,提供InputMethodExtensionAbility具有的能力和接口,包括启动、停止、绑定、解绑Ability。
Z
zhaolinglan 已提交
4

H
update  
Hollokin 已提交
5 6 7
> **说明:**
>
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。  
Z
zhaolinglan 已提交
8

Z
zhaolinglan 已提交
9 10 11
## 导入模块

```
12
import InputMethodExtensionContext from '@ohos.InputMethodExtensionContext';
Z
zhaolinglan 已提交
13 14
```

Z
zhaolinglan 已提交
15 16 17 18
## 使用说明

在使用InputMethodExtensionContext的功能前,需要通过InputMethodExtensionAbility子类实例获取。

H
Hollokin 已提交
19
```js
20
import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
21
class EntryAbility extends InputMethodExtensionAbility {
22 23 24
  onCreate() {
    let context = this.context;
  }
H
Hollokin 已提交
25
}
Z
zhaolinglan 已提交
26 27
```

H
Hollokin 已提交
28
## InputMethodExtensionContext.destroy
H
Hollokin 已提交
29

H
Hollokin 已提交
30
destroy(callback: AsyncCallback\<void>): void
H
Hollokin 已提交
31

N
update  
ningning 已提交
32
销毁输入法应用。使用callback异步回调。
H
Hollokin 已提交
33

H
update  
Hollokin 已提交
34
**系统能力:** SystemCapability.MiscServices.InputMethodFramework
H
Hollokin 已提交
35 36 37

**参数:**

H
Hollokin 已提交
38 39
| 参数名   | 类型                 | 必填 | 说明                                                         |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
N
update  
ningning 已提交
40
| callback | AsyncCallback\<void> | 是   | 回调函数。当销毁输入法应用成功时,err为undefined;否则为错误对象。 |
H
Hollokin 已提交
41 42 43

**示例:**

H
Hollokin 已提交
44
```js
H
Hollokin 已提交
45 46
this.context.destroy(() => {
  console.log('Succeeded in destroying context.');
H
Hollokin 已提交
47 48 49
});
```

H
Hollokin 已提交
50
## InputMethodExtensionContext.destroy
H
Hollokin 已提交
51

52
destroy(): Promise\<void>;
H
Hollokin 已提交
53

N
update  
ningning 已提交
54
销毁输入法应用。使用Promise异步回调。
H
Hollokin 已提交
55

H
update  
Hollokin 已提交
56
**系统能力:** SystemCapability.MiscServices.InputMethodFramework
H
Hollokin 已提交
57 58 59 60 61

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
N
update  
ningning 已提交
62
| Promise\<void> | 无返回结果的Promise对象。 |
H
Hollokin 已提交
63 64 65

**示例:**

H
Hollokin 已提交
66
```js
67
this.context.destroy().then(() => {
H
Hollokin 已提交
68
  console.log('Succeed in destroying context.');
H
Hollokin 已提交
69
});
70
```