harmony 鸿蒙@ohos.app.form.FormEditExtensionAbility (FormEditExtensionAbility)

2025-06-12
浏览 (7)

@ohos.app.form.FormEditExtensionAbility (FormEditExtensionAbility)

The FormEditExtensionAbility module, inherited from UIExtensionAbility, provides the widget editing function.

NOTE

The initial APIs of this module are supported since API version 18. 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 { FormEditExtensionAbility } from '@kit.FormKit';

Properties

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.Ability.Form |Name|Type |Read-Only|Optional|Description| |——|——|—-|—-|—-| |context| FormEditExtensionContext|No|No|Context of FormEditExtensionAbility. The default value is an object inherited from UIExtensionContext.
Atomic service API: This API can be used in atomic services since API version 18.|

FormEditExtensionAbility.onCreate

onCreate(launchParam: AbilityConstant.LaunchParam): void

Called when FormEditExtensionAbility is created.

Model restriction: This API can be used only in the stage model.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Ability.Form

Parameters

Name	Type	Mandatory	Description
launchParam	AbilityConstant.LaunchParam	Yes	Launch parameter when FormEditExtensionAbility is created.

Example

import { FormEditExtensionAbility } from '@kit.FormKit';
import { AbilityConstant } from '@kit.AbilityKit';

const TAG: string = '[testTag] ExampleFormEditExtensionAbility';
export default class ExampleFomrEditAbility extends FormEditExtensionAbility {
  onCreate(launchParam: AbilityConstant.LaunchParam) {
    console.info(TAG, `onCreate`);
    console.log(`onCreate, launchParam: ${JSON.stringify(launchParam)}`);
  }
}

FormEditExtensionAbility.onSessionCreate

onSessionCreate(want: Want, session: UIExtensionContentSession): void

Loads a widget page. This method is called after the UI content of FormEditExtensionAbility is created.

Model restriction: This API can be used only in the stage model.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Ability.Form

Parameters

Name	Type	Mandatory	Description
want	Want	Yes	Want information of FormEditExtensionAbility, including the ability name and bundle.
session	UIExtensionContentSession	Yes	UIExtensionContentSession object created when the UI content is loaded.

Example

import { FormEditExtensionAbility } from '@kit.FormKit';
import { Want,UIExtensionContentSession } from '@kit.AbilityKit';

const TAG: string = '[testTag] ExampleFormEditAbility';
export default class ExampleFormEditAbility extends FormEditExtensionAbility {
  onSessionCreate(want: Want, session: UIExtensionContentSession) {
    console.info(TAG, `onSessionCreate want: ${JSON.stringify(want)}`);
  }
}

FormEditExtensionAbility.onSessionDestroy

onSessionDestroy(session: UIExtensionContentSession): void

Called after the UI content of FormEditExtensionAbility is destroyed.

Model restriction: This API can be used only in the stage model.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Ability.Form

Parameters

Name	Type	Mandatory	Description
session	UIExtensionContentSession	Yes	UIExtensionContentSession object created when the UI content is loaded.

Example

import { FormEditExtensionAbility } from '@kit.FormKit';
import { UIExtensionContentSession } from '@kit.AbilityKit';

const TAG: string = '[testTag] ExampleFormEditAbility';
export default class ExampleFormEditAbility extends FormEditExtensionAbility{
  onSessionDestroy() {
    console.info(TAG, `onSessionDestroy`);
  }
}

FormEditExtensionAbility.onForeground

onForeground(): void

Called when FormEditExtensionAbility is switched from the background to the foreground.

Model restriction: This API can be used only in the stage model.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Ability.Form

Example

import { FormEditExtensionAbility } from '@kit.FormKit';

const TAG: string = '[testTag] ExampleFormEditAbility';
export default class ExampleFormEditAbility extends FormEditExtensionAbility{
  onForeground() {
    console.info(TAG, `onForeground`);
  }
}

FormEditExtensionAbility.onBackground

onBackground(): void

Called when FormEditExtensionAbility is switched from the foreground to the background.

Model restriction: This API can be used only in the stage model.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Ability.Form

Example

import { FormEditExtensionAbility } from '@kit.FormKit';

const TAG: string = '[testTag] ExampleFormEditAbility';
export default class ExampleFormEditAbility extends FormEditExtensionAbility{
  onBackground() {
    console.info(TAG, `onBackground`);
  }
}

FormEditExtensionAbility.onDestroy

onDestroy(): void|Promise<void>

Called when FormEditExtensionAbility is destroyed to clear resources.

Model restriction: This API can be used only in the stage model.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Ability.Form

Example

import { FormEditExtensionAbility } from '@kit.FormKit';

const TAG: string = '[testTag] ExampleFormEditAbility';
export default class ExampleFormEditAbility extends FormEditExtensionAbility{
  onDestroy() {
    console.info(TAG, `onDestroy`);
  }
}