@ohos.InputMethodExtensionAbility (InputMethodExtensionAbility)

The InputMethodExtensionAbility module provides APIs for developing input methods and managing the lifecycle of input method extensions.

NOTE

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. The APIs of this module can be used only in the stage model.

Modules to Import

import { InputMethodExtensionAbility } from '@kit.IMEKit';

InputMethodExtensionAbility

Defines the InputMethodExtensionAbility class.

System capability: SystemCapability.MiscServices.InputMethodFramework

Properties

Context of the InputMethodExtensionAbility.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-Only	Optional	Description
context	InputMethodExtensionContext	No	No	Context of the InputMethodExtension, which is inherited from ExtensionContext.

onCreate

onCreate(want: Want): void

Called when the InputMethodExtensionAbility is started to implement initialization.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
want	Want	Yes	Information related to the InputMethodExtensionAbility, including the ability name and bundle name.

Example

import { InputMethodExtensionAbility } from '@kit.IMEKit';
import { Want } from '@kit.AbilityKit';

class InputMethodExt extends InputMethodExtensionAbility {
  onCreate(want: Want): void {
    console.info('onCreate, want:' + want.abilityName);
  }
}

onDestroy

onDestroy(): void

Called when this InputMethodExtensionAbility is destroyed to clear resources.

System capability: SystemCapability.MiscServices.InputMethodFramework

Example

import { InputMethodExtensionAbility } from '@kit.IMEKit';

class InputMethodExt extends InputMethodExtensionAbility {
  onDestroy(): void {
    console.info('onDestroy');
  }
}