• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.InputMethodExtensionAbility (InputMethodExtensionAbility)
2<!--Kit: IME Kit-->
3<!--Subsystem: MiscServices-->
4<!--Owner: @illybyy-->
5<!--Designer: @andeszhang-->
6<!--Tester: @murphy1984-->
7<!--Adviser: @zhang_yixin13-->
8
9本模块支持开发者自行开发输入法应用,以及管理输入法应用的生命周期。
10
11> **说明:**
12>
13> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
14> 本模块接口仅可在Stage模型下使用。
15
16## 导入模块
17
18```ts
19import { InputMethodExtensionAbility } from '@kit.IMEKit';
20```
21
22## InputMethodExtensionAbility
23
24输入法Extension ability类。
25
26**系统能力:** SystemCapability.MiscServices.InputMethodFramework
27
28### 属性
29
30输入法Extension ability的上下文信息。
31
32**系统能力:** SystemCapability.MiscServices.InputMethodFramework
33
34| 名称 | 类型 | 只读 | 可选 | 说明 |
35| -------- | -------- | -------- | -------- | -------- |
36| context | [InputMethodExtensionContext](js-apis-inputmethod-extension-context.md) | 否 | 否 | InputMethodExtension的上下文环境,继承于ExtensionContext。 |
37
38### onCreate
39
40onCreate(want: Want): void
41
42Extension生命周期回调,在拉起Extension输入法应用时调用,执行初始化输入法应用操作。
43
44**系统能力:** SystemCapability.MiscServices.InputMethodFramework
45
46**参数:**
47
48| 参数名 | 类型          | 必填 | 说明                             |
49| ------ | ----------- | ---- | ------------------------------- |
50| want   | [Want](../apis-ability-kit/js-apis-app-ability-want.md) | 是   | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
51
52**示例:**
53
54```ts
55import { InputMethodExtensionAbility } from '@kit.IMEKit';
56import { Want } from '@kit.AbilityKit';
57
58class InputMethodExt extends InputMethodExtensionAbility {
59  onCreate(want: Want): void {
60    console.info('onCreate, want:' + want.abilityName);
61  }
62}
63```
64
65### onDestroy
66
67onDestroy(): void
68
69Extension生命周期回调,在销毁输入法应用时回调,执行资源清理等操作。
70
71**系统能力:** SystemCapability.MiscServices.InputMethodFramework
72
73**示例:**
74
75```ts
76import { InputMethodExtensionAbility } from '@kit.IMEKit';
77
78class InputMethodExt extends InputMethodExtensionAbility {
79  onDestroy(): void {
80    console.info('onDestroy');
81  }
82}
83```
84