• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.InputMethodExtensionAbility (InputMethodExtensionAbility)
2
3The **InputMethodExtensionAbility** module provides APIs for developing input methods and managing their lifecycles.
4
5> **NOTE**
6>
7> 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.
8> The APIs of this module can be used only in the stage model.
9
10## Modules to Import
11
12```ts
13import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
14```
15
16## Attributes
17
18**System capability**: SystemCapability.MiscServices.InputMethodFramework
19
20| Name| Type| Readable| Writable| Description|
21| -------- | -------- | -------- | -------- | -------- |
22| context | [InputMethodExtensionContext](js-apis-inputmethod-extension-context.md) | Yes| No| Context of the **InputMethodExtension**, which is inherited from **ExtensionContext**.|
23
24## InputMethodExtensionAbility.onCreate
25
26onCreate(want: Want): void
27
28Called when the **InputMethodExtension** ability is started to implement initialization.
29
30**System capability**: SystemCapability.MiscServices.InputMethodFramework
31
32**Parameters**
33
34| Name| Type         | Mandatory| Description                            |
35| ------ | ----------- | ---- | ------------------------------- |
36| want   | [Want](js-apis-app-ability-want.md) | Yes  | Information related to the **InputMethodExtension** ability, including the ability name and bundle name.|
37
38**Example**
39
40```ts
41import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
42import Want from '@ohos.app.ability.Want';
43class InputMethodExt extends InputMethodExtensionAbility {
44  onCreate(want: Want): void {
45    console.log('onCreate, want:' + want.abilityName);
46  }
47}
48```
49
50## InputMethodExtensionAbility.onDestroy
51
52onDestroy(): void
53
54Called when this **InputMethodExtension** ability is destroyed to clear resources.
55
56**System capability**: SystemCapability.MiscServices.InputMethodFramework
57
58**Example**
59
60```ts
61import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
62class InputMethodExt extends InputMethodExtensionAbility {
63  onDestroy(): void {
64    console.log('onDestroy');
65  }
66}
67```
68