• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16import UIAbility from '../@ohos.app.ability.UIAbility';
17
18/**
19 * Provide methods for matching monitored Ability objects that meet specified conditions.
20 * The most recently matched Ability objects will be saved in the AbilityMonitor object.
21 *
22 * @since 9
23 * @syscap SystemCapability.Ability.AbilityRuntime.Core
24 * @permission N/A
25 */
26export interface AbilityMonitor {
27    /**
28     * The name of the ability to monitor.
29     *
30     * @since 9
31     * @syscap SystemCapability.Ability.AbilityRuntime.Core
32     */
33    abilityName: string;
34
35    /**
36     * The name of the module to monitor.
37     *
38     * @since 9
39     * @syscap SystemCapability.Ability.AbilityRuntime.Core
40     */
41    moduleName?: string;
42
43    /**
44     * Called back when the ability is created for initialization.
45     *
46     * @since 9
47     * @syscap SystemCapability.Ability.AbilityRuntime.Core
48     */
49    onAbilityCreate?:(ability: UIAbility) => void;
50
51    /**
52     * Called back when the state of the ability changes to foreground.
53     *
54     * @since 9
55     * @syscap SystemCapability.Ability.AbilityRuntime.Core
56     */
57    onAbilityForeground?:(ability: UIAbility) => void;
58
59    /**
60     * Called back when the state of the ability changes to background.
61     *
62     * @since 9
63     * @syscap SystemCapability.Ability.AbilityRuntime.Core
64     */
65    onAbilityBackground?:(ability: UIAbility) => void;
66
67    /**
68     * Called back before the ability is destroyed.
69     *
70     * @since 9
71     * @syscap SystemCapability.Ability.AbilityRuntime.Core
72     */
73    onAbilityDestroy?:(ability: UIAbility) => void;
74
75    /**
76     * Called back when an ability window stage is created.
77     *
78     * @since 9
79     * @syscap SystemCapability.Ability.AbilityRuntime.Core
80     */
81    onWindowStageCreate?:(ability: UIAbility) => void;
82
83    /**
84     * Called back when an ability window stage is restored.
85     *
86     * @since 9
87     * @syscap SystemCapability.Ability.AbilityRuntime.Core
88     */
89    onWindowStageRestore?:(ability: UIAbility) => void;
90
91    /**
92     * Called back when an ability window stage is destroyed.
93     *
94     * @since 9
95     * @syscap SystemCapability.Ability.AbilityRuntime.Core
96     */
97    onWindowStageDestroy?:(ability: UIAbility) => void;
98}
99
100export default AbilityMonitor;