diff --git a/api/application/AbilityDelegator.d.ts b/api/application/AbilityDelegator.d.ts index 17dc00c762176f453e10055d840652f05bf5228b..789da6c66116ad0f8da26004939acf38a621d4cd 100644 --- a/api/application/AbilityDelegator.d.ts +++ b/api/application/AbilityDelegator.d.ts @@ -29,6 +29,14 @@ import { ShellCmdResult } from './shellCmdResult'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ +/** + * A global test utility interface used for adding AbilityMonitor objects and control lifecycle states of abilities. + * + * @interface AbilityDelegator + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ export interface AbilityDelegator { /** * Add an AbilityMonitor object for monitoring the lifecycle state changes of the specified ability in this process. diff --git a/api/application/AbilityMonitor.d.ts b/api/application/AbilityMonitor.d.ts index 9717aad0ffdb9b6d39ddb9bf1e39d27e5af178fe..e1046cca856aaef2135cef90a244ed1e019f9d09 100644 --- a/api/application/AbilityMonitor.d.ts +++ b/api/application/AbilityMonitor.d.ts @@ -23,6 +23,15 @@ import UIAbility from '../@ohos.app.ability.UIAbility'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ +/** + * Provide methods for matching monitored Ability objects that meet specified conditions. + * The most recently matched Ability objects will be saved in the AbilityMonitor object. + * + * @interface AbilityMonitor + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ export interface AbilityMonitor { /** * The name of the ability to monitor. @@ -31,6 +40,14 @@ export interface AbilityMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * The name of the ability to monitor. + * + * @type { string } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ abilityName: string; /** @@ -40,6 +57,14 @@ export interface AbilityMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * The name of the module to monitor. + * + * @type { ?string } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ moduleName?: string; /** @@ -48,6 +73,13 @@ export interface AbilityMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * Called back when the ability is created for initialization. + * + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ onAbilityCreate?: (ability: UIAbility) => void; /** @@ -56,6 +88,13 @@ export interface AbilityMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * Called back when the state of the ability changes to foreground. + * + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ onAbilityForeground?: (ability: UIAbility) => void; /** @@ -64,6 +103,13 @@ export interface AbilityMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * Called back when the state of the ability changes to background. + * + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ onAbilityBackground?: (ability: UIAbility) => void; /** @@ -72,6 +118,13 @@ export interface AbilityMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * Called back before the ability is destroyed. + * + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ onAbilityDestroy?: (ability: UIAbility) => void; /** @@ -80,6 +133,13 @@ export interface AbilityMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * Called back when an ability window stage is created. + * + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ onWindowStageCreate?: (ability: UIAbility) => void; /** @@ -96,6 +156,13 @@ export interface AbilityMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * Called back when an ability window stage is destroyed. + * + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ onWindowStageDestroy?: (ability: UIAbility) => void; } diff --git a/api/application/AbilityStageMonitor.d.ts b/api/application/AbilityStageMonitor.d.ts index 987abee8d45d40fa5790f8374655a76e854ea927..0ef1d30920129b94e3668c7092ef9ccb9c1a6149 100644 --- a/api/application/AbilityStageMonitor.d.ts +++ b/api/application/AbilityStageMonitor.d.ts @@ -21,6 +21,15 @@ * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ +/** + * Provide methods for matching monitored AbilityStage objects that meet specified conditions. + * The most recently matched AbilityStage objects will be saved in the AbilityStageMonitor object. + * + * @typedef AbilityStageMonitor + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ export interface AbilityStageMonitor { /** * The module name of the abilityStage to monitor. @@ -29,6 +38,14 @@ export interface AbilityStageMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * The module name of the abilityStage to monitor. + * + * @type { string } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ moduleName: string; /** @@ -38,6 +55,14 @@ export interface AbilityStageMonitor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @since 9 */ + /** + * The source path of the abilityStage to monitor. + * + * @type { string } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @since 10 + */ srcEntrance: string; }