js-apis-inputmethod-extension-ability.md 2.0 KB
Newer Older
1
# @ohos.InputMethodExtensionAbility (InputMethodExtensionAbility)
Z
zhaolinglan 已提交
2

N
update  
ningning 已提交
3
本模块支持开发者自行开发输入法应用,以及管理输入法应用的生命周期。
Z
zhaolinglan 已提交
4

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

## 导入模块

11
```ts
12
import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
Z
zhaolinglan 已提交
13 14 15 16
```

## 属性

H
update  
Hollokin 已提交
17
**系统能力:** SystemCapability.MiscServices.InputMethodFramework
Z
zhaolinglan 已提交
18

19
| 名称 | 类型 | 可读 | 可写 | 说明 |
Z
zhaolinglan 已提交
20
| -------- | -------- | -------- | -------- | -------- |
N
update  
ningning 已提交
21
| context | [InputMethodExtensionContext](js-apis-inputmethod-extension-context.md) | 是 | 否 | InputMethodExtension的上下文环境,继承于ExtensionContext。 |
Z
zhaolinglan 已提交
22

23
## InputMethodExtensionAbility.onCreate
Z
zhaolinglan 已提交
24

H
Hollokin 已提交
25
onCreate(want: Want): void
Z
zhaolinglan 已提交
26

Z
zhaolinglan 已提交
27
Extension生命周期回调,在拉起Extension输入法应用时调用,执行初始化输入法应用操作。
Z
zhaolinglan 已提交
28

H
update  
Hollokin 已提交
29
**系统能力:** SystemCapability.MiscServices.InputMethodFramework
Z
zhaolinglan 已提交
30 31 32

**参数:**

33 34
| 参数名 | 类型          | 必填 | 说明                             |
| ------ | ----------- | ---- | ------------------------------- |
Z
zhongjianfei 已提交
35
| want   | [Want](js-apis-app-ability-want.md) | 是   | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
Z
zhaolinglan 已提交
36 37 38

**示例:**

39 40 41
```ts
import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
import Want from '@ohos.app.ability.Want';
H
Hollokin 已提交
42
class InputMethodExt extends InputMethodExtensionAbility {
43
  onCreate(want: Want): void {
44 45
    console.log('onCreate, want:' + want.abilityName);
  }
H
Hollokin 已提交
46 47
}
```
Z
zhaolinglan 已提交
48

49
## InputMethodExtensionAbility.onDestroy
Z
zhaolinglan 已提交
50

H
Hollokin 已提交
51
onDestroy(): void
Z
zhaolinglan 已提交
52

Z
zhaolinglan 已提交
53
Extension生命周期回调,在销毁输入法应用时回调,执行资源清理等操作。
Z
zhaolinglan 已提交
54

H
update  
Hollokin 已提交
55
**系统能力:** SystemCapability.MiscServices.InputMethodFramework
Z
zhaolinglan 已提交
56 57 58

**示例:**

59 60
```ts
import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
H
Hollokin 已提交
61
class InputMethodExt extends InputMethodExtensionAbility {
62
  onDestroy(): void {
63 64
    console.log('onDestroy');
  }
H
Hollokin 已提交
65
}
66
```