• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-2023 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
16/**
17 * @file
18 * @kit AbilityKit
19 */
20
21import AppStateData from './AppStateData';
22import AbilityStateData from './AbilityStateData';
23import * as _ProcessData from './ProcessData';
24
25/**
26 * The application state observer.
27 *
28 * @syscap SystemCapability.Ability.AbilityRuntime.Core
29 * @systemapi
30 * @since 8
31 */
32export default class ApplicationStateObserver {
33  /**
34   * Will be called when foreground or background application changed.
35   *
36   * @param { AppStateData } appStateData - State changed Application info.
37   * @syscap SystemCapability.Ability.AbilityRuntime.Core
38   * @systemapi
39   * @since 8
40   */
41  onForegroundApplicationChanged(appStateData: AppStateData): void;
42
43  /**
44   * Will be called when ability state changed.
45   *
46   * @param { AbilityStateData } abilityStateData - State changed ability info.
47   * @syscap SystemCapability.Ability.AbilityRuntime.Core
48   * @systemapi
49   * @since 8
50   */
51  onAbilityStateChanged(abilityStateData: AbilityStateData): void;
52
53  /**
54   * Will be called when process created.
55   *
56   * @param { ProcessData } processData - Process info.
57   * @syscap SystemCapability.Ability.AbilityRuntime.Core
58   * @systemapi
59   * @since 8
60   */
61  onProcessCreated(processData: ProcessData): void;
62
63  /**
64   * Will be called when process died.
65   *
66   * @param { ProcessData } processData - Process info.
67   * @syscap SystemCapability.Ability.AbilityRuntime.Core
68   * @systemapi
69   * @since 8
70   */
71  onProcessDied(processData: ProcessData): void;
72
73  /**
74   * Called when process state changes.
75   *
76   * @param { ProcessData } processData - Process info.
77   * @syscap SystemCapability.Ability.AbilityRuntime.Core
78   * @systemapi
79   * @since 9
80   */
81  onProcessStateChanged(processData: ProcessData): void;
82
83  /**
84   * Called when application is started.
85   *
86   * @param { AppStateData } appStateData - State changed Application info.
87   * @syscap SystemCapability.Ability.AbilityRuntime.Core
88   * @systemapi
89   * @since 12
90   */
91  onAppStarted(appStateData: AppStateData): void;
92
93  /**
94   * Called when application is stopped.
95   *
96   * @param { AppStateData } appStateData - State changed Application info.
97   * @syscap SystemCapability.Ability.AbilityRuntime.Core
98   * @systemapi
99   * @since 12
100   */
101  onAppStopped(appStateData: AppStateData): void;
102}
103
104/**
105 * The process data.
106 * @typedef { _ProcessData.default }
107 * @syscap SystemCapability.Ability.AbilityRuntime.Core
108 * @systemapi
109 * @since 9
110 */
111export type ProcessData = _ProcessData.default;
112