js-apis-inputmethod-extension-context.md 2.2 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
```ts
12
import InputMethodExtensionContext from '@ohos.InputMethodExtensionContext';
Z
zhaolinglan 已提交
13 14
```

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

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

19
```ts
20
import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
21 22 23
import Want from '@ohos.app.ability.Want';
class InputMethodExtnAbility extends InputMethodExtensionAbility {
  onCreate(want: Want): void {
24 25
    let context = this.context;
  }
H
Hollokin 已提交
26
}
Z
zhaolinglan 已提交
27 28
```

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

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

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

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

**参数:**

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

**示例:**

45 46 47 48 49 50
```ts
this.context.destroy((err: Error) => {
  if(err) {
    console.log('Failed to destroy context.');
    return;
  }
H
Hollokin 已提交
51
  console.log('Succeeded in destroying context.');
H
Hollokin 已提交
52 53 54
});
```

H
Hollokin 已提交
55
## InputMethodExtensionContext.destroy
H
Hollokin 已提交
56

57
destroy(): Promise\<void>;
H
Hollokin 已提交
58

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

H
update  
Hollokin 已提交
61
**系统能力:** SystemCapability.MiscServices.InputMethodFramework
H
Hollokin 已提交
62 63 64 65 66

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
N
update  
ningning 已提交
67
| Promise\<void> | 无返回结果的Promise对象。 |
H
Hollokin 已提交
68 69 70

**示例:**

71
```ts
72
this.context.destroy().then(() => {
H
Hollokin 已提交
73
  console.log('Succeed in destroying context.');
74 75
}).catch((err: Error)=>{
  console.log('Failed to destroy context.');
H
Hollokin 已提交
76
});
77
```