• 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
16/**
17 * @file
18 * @kit AbilityKit
19 */
20
21import { AbilityInfo } from './abilityInfo';
22
23/**
24 * Obtains configuration information about a module.
25 *
26 * @typedef HapModuleInfo
27 * @syscap SystemCapability.BundleManager.BundleFramework
28 * @since 7
29 * @deprecated since 9
30 * @useinstead ohos.bundle.bundleManager.HapModuleInfo
31 */
32export interface HapModuleInfo {
33  /**
34   * @type { string }
35   * @default Indicates the name of this hapmodule
36   * @syscap SystemCapability.BundleManager.BundleFramework
37   * @since 7
38   * @deprecated since 9
39   */
40  readonly name: string;
41  /**
42   * @type { string }
43   * @default Describes the hapmodule
44   * @syscap SystemCapability.BundleManager.BundleFramework
45   * @since 7
46   * @deprecated since 9
47   */
48  readonly description: string;
49  /**
50   * @type { number }
51   * @default Indicates the description of this hapmodule
52   * @syscap SystemCapability.BundleManager.BundleFramework
53   * @since 7
54   * @deprecated since 9
55   */
56  readonly descriptionId: number;
57  /**
58   * @type { string }
59   * @default Indicates the icon of this hapmodule
60   * @syscap SystemCapability.BundleManager.BundleFramework
61   * @since 7
62   * @deprecated since 9
63   */
64  readonly icon: string;
65  /**
66   * @type { string }
67   * @default Indicates the label of this hapmodule
68   * @syscap SystemCapability.BundleManager.BundleFramework
69   * @since 7
70   * @deprecated since 9
71   */
72  readonly label: string;
73  /**
74   * @type { number }
75   * @default Indicates the label id of this hapmodule
76   * @syscap SystemCapability.BundleManager.BundleFramework
77   * @since 7
78   * @deprecated since 9
79   */
80  readonly labelId: number;
81  /**
82   * @type { number }
83   * @default Indicates the icon id of this hapmodule
84   * @syscap SystemCapability.BundleManager.BundleFramework
85   * @since 7
86   * @deprecated since 9
87   */
88  readonly iconId: number;
89  /**
90   * @type { string }
91   * @default Indicates the background img of this hapmodule
92   * @syscap SystemCapability.BundleManager.BundleFramework
93   * @since 7
94   * @deprecated since 9
95   */
96  readonly backgroundImg: string;
97  /**
98   * @type { number }
99   * @default Indicates the supported modes of this hapmodule
100   * @syscap SystemCapability.BundleManager.BundleFramework
101   * @since 7
102   * @deprecated since 9
103   */
104  readonly supportedModes: number;
105  /**
106   * @type { Array<string> }
107   * @default Indicates the req capabilities of this hapmodule
108   * @syscap SystemCapability.BundleManager.BundleFramework
109   * @since 7
110   * @deprecated since 9
111   */
112  readonly reqCapabilities: Array<string>;
113  /**
114   * @type { Array<string> }
115   * @default The device types that this hapmodule can run on
116   * @syscap SystemCapability.BundleManager.BundleFramework
117   * @since 7
118   * @deprecated since 9
119   */
120  readonly deviceTypes: Array<string>;
121  /**
122   * @type { Array<AbilityInfo> }
123   * @default Obtains configuration information about ability
124   * @syscap SystemCapability.BundleManager.BundleFramework
125   * @since 7
126   * @deprecated since 9
127   */
128  readonly abilityInfo: Array<AbilityInfo>;
129  /**
130   * @type { string }
131   * @default Indicates the name of the .hap package to which the capability belongs
132   * @syscap SystemCapability.BundleManager.BundleFramework
133   * @since 7
134   * @deprecated since 9
135   */
136  readonly moduleName: string;
137  /**
138   * @type { string }
139   * @default Indicates the main ability name of this hapmodule
140   * @syscap SystemCapability.BundleManager.BundleFramework
141   * @since 7
142   * @deprecated since 9
143   */
144  readonly mainAbilityName: string;
145  /**
146   * @type { boolean }
147   * @default Indicates whether free installation of the hapmodule is supported
148   * @syscap SystemCapability.BundleManager.BundleFramework
149   * @since 7
150   * @deprecated since 9
151   */
152  readonly installationFree: boolean;
153}
154