• 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
9The **InputMethodExtensionAbility** module provides APIs for developing input methods and managing their lifecycles.
10
11> **NOTE**
12>
13> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
14> The APIs of this module can be used only in the stage model.
15
16## Modules to Import
17
18```ts
19import { InputMethodExtensionAbility } from '@kit.IMEKit';
20```
21
22## InputMethodExtensionAbility
23
24Defines the **InputMethodExtensionAbility** class.
25
26**System capability**: SystemCapability.MiscServices.InputMethodFramework
27
28### Properties
29
30Context of the **InputMethodExtensionAbility**.
31
32**System capability**: SystemCapability.MiscServices.InputMethodFramework
33
34| Name| Type| Read-Only| Optional| Description|
35| -------- | -------- | -------- | -------- | -------- |
36| context | [InputMethodExtensionContext](js-apis-inputmethod-extension-context.md) | No| No| Context of the **InputMethodExtension**, which is inherited from **ExtensionContext**.|
37
38### onCreate
39
40onCreate(want: Want): void
41
42Called when the **InputMethodExtensionAbility** is started to implement initialization.
43
44**System capability**: SystemCapability.MiscServices.InputMethodFramework
45
46**Parameters**
47
48| Name| Type         | Mandatory| Description                            |
49| ------ | ----------- | ---- | ------------------------------- |
50| want   | [Want](../apis-ability-kit/js-apis-app-ability-want.md) | Yes  | Information related to the **InputMethodExtensionAbility**, including the ability name and bundle name.|
51
52**Example**
53
54```ts
55import { InputMethodExtensionAbility } from '@kit.IMEKit';
56import { Want } from '@kit.AbilityKit';
57class InputMethodExt extends InputMethodExtensionAbility {
58  onCreate(want: Want): void {
59    console.info('onCreate, want:' + want.abilityName);
60  }
61}
62```
63
64### onDestroy
65
66onDestroy(): void
67
68Called when this **InputMethodExtensionAbility** is destroyed to clear resources.
69
70**System capability**: SystemCapability.MiscServices.InputMethodFramework
71
72**Example**
73
74```ts
75import { InputMethodExtensionAbility } from '@kit.IMEKit';
76class InputMethodExt extends InputMethodExtensionAbility {
77  onDestroy(): void {
78    console.info('onDestroy');
79  }
80}
81```
82