js-apis-inputmethod-extension-context.md 2.1 KB
Newer Older
Z
zhaolinglan 已提交
1 2 3 4 5 6
# InputMethodExtensionContext

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

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

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

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

```
import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext';
```

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

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

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

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

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

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

**系统能力**:SystemCapability.MiscServices.InputMethodFramework

**参数:**

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

**示例:**

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

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

H
Hollokin 已提交
52
destroy(): Promise<void&gt;;
H
Hollokin 已提交
53

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

**系统能力**:SystemCapability.MiscServices.InputMethodFramework

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
H
Hollokin 已提交
62
| Promise<void&gt; | 无返回结果的Promise对象。 |
H
Hollokin 已提交
63 64 65

**示例:**

H
Hollokin 已提交
66
```js
H
Hollokin 已提交
67 68 69 70 71 72
this.context.destroy().then((data) => {
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});
```