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

InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境,继承自ExtensionContext。

InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能力和接口,包括启动、停止、绑定、解绑Ability。

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

Z
zhaolinglan 已提交
11 12 13
## 导入模块

```
14
import InputMethodExtensionContext from '@ohos.InputMethodExtensionContext';
Z
zhaolinglan 已提交
15 16
```

Z
zhaolinglan 已提交
17 18 19 20
## 使用说明

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

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

H
Hollokin 已提交
30
## InputMethodExtensionContext.destroy
H
Hollokin 已提交
31

H
Hollokin 已提交
32
destroy(callback: AsyncCallback\<void>): void
H
Hollokin 已提交
33 34 35

停止输入法应用自身。使用callback异步回调。

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

**参数:**

H
Hollokin 已提交
40 41
| 参数名   | 类型                 | 必填 | 说明                                                         |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
H
Hollokin 已提交
42
| callback | AsyncCallback\<void> | 是   | 回调函数。当停止输入法应用自身成功时,err为undefined;否则为错误对象。 |
H
Hollokin 已提交
43 44 45

**示例:**

H
Hollokin 已提交
46
```js
H
Hollokin 已提交
47 48 49 50 51
this.context.destroy((err) => {
    console.log('destroy result:' + JSON.stringify(err));
});
```

H
Hollokin 已提交
52
## InputMethodExtensionContext.destroy
H
Hollokin 已提交
53

54
destroy(): Promise\<void>;
H
Hollokin 已提交
55

H
Hollokin 已提交
56
停止输入法应用自身。通过Promise异步回调。
H
Hollokin 已提交
57

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
64
| Promise\<void>; | 无返回结果的Promise对象。 |
H
Hollokin 已提交
65 66 67

**示例:**

H
Hollokin 已提交
68
```js
69 70
this.context.destroy().then(() => {
    console.log('Succeed in destoring context.');
H
Hollokin 已提交
71
}).catch((error) => {
72
    console.log('Failed to destory context: ' + JSON.stringify(error));
H
Hollokin 已提交
73
});
74
```