• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 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
21/**
22 * Obtains configuration information about a overlay hap module.
23 *
24 * @typedef OverlayModuleInfo
25 * @syscap SystemCapability.BundleManager.BundleFramework.Core
26 * @since 10
27 */
28export interface OverlayModuleInfo {
29  /**
30   * Indicates the name of the bundle
31   *
32   * @type { string }
33   * @readonly
34   * @syscap SystemCapability.BundleManager.BundleFramework.Core
35   * @since 10
36   */
37  readonly bundleName: string;
38
39  /**
40   * Indicates the name of the .hap package to which the capability belongs
41   *
42   * @type { string }
43   * @readonly
44   * @syscap SystemCapability.BundleManager.BundleFramework.Core
45   * @since 10
46   */
47  readonly moduleName: string;
48
49  /**
50   * Indicates the name of target module which is overlaid by the overlay module
51   *
52   * @type { string }
53   * @readonly
54   * @syscap SystemCapability.BundleManager.BundleFramework.Core
55   * @since 10
56   */
57  readonly targetModuleName: string;
58
59  /**
60   * Indicates the priority of the overlay module
61   *
62   * @type { number }
63   * @readonly
64   * @syscap SystemCapability.BundleManager.BundleFramework.Core
65   * @since 10
66   */
67  readonly priority: number;
68
69  /**
70   * Indicates the state of the overlay module
71   *
72   * @type { number }
73   * @readonly
74   * @syscap SystemCapability.BundleManager.BundleFramework.Core
75   * @since 10
76   */
77  readonly state: number;
78}
79