• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Bundle Manager Subsystem Changelog
2
3## cl.bundlemanager.1 Deleted getAbilityIcon
4
5The **getAbilityIcon** API in [@ohos.bundle.bundleManager.d.ts](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/@ohos.bundle.bundleManager.d.ts) is deleted. The **getMediaContent** API in [@ohos.resourceManager.d.ts](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/@ohos.resourceManager.d.ts) can be used instead.
6
7**Change Impact**<br>
8The **getAbilityIcon** API does not take effect.
9
10**Key API/Component Changes**<br>
11The **getAbilityIcon** API is deleted from **@ohos.bundle.bundleManager.d.ts**.
12
13**Adaptation Guide**<br>
14If your application uses **getAbilityIcon** in **@ohos.bundle.bundleManager.d.ts**, replace it with **getMediaContent** in **@ohos.resourceManager.d.ts**. You need to obtain the icon ID in advance. For details, see [Usage Guide](../../../application-dev/reference/apis/js-apis-resource-manager.md#getmediacontent9).
15
16## cl.bundlemanager.2 Bottom-Layer Capability Changed So That Only the System Resource HAP Supports Custom Permissions
17
18Only the system resource HAP supports custom permissions. During HAP parsing, the bundle manager module parses the **definePermissions** field only in the configuration file of the resource HAP (bundle name: **ohos.global.systemres**), but not this field in other HAPs. This field is used to define permissions.
19If an application requires custom permissions, add the permissions under the **definePermissions** field in the [configuration file](https://gitee.com/openharmony/utils_system_resources/blob/master/systemres/main/config.json) of the system resource HAP. For details about the permission format, see [Defining Permissions](../../../application-dev/quick-start/module-structure.md#internal-structure-of-the-definepermissions-attribute).
20
21
22**Change Impact**<br>
23After an upgrade to the new version image, the custom permission of the application does not take effect, and the authorization fails.
24
25**Key API/Component Changes**<br>
26The bottom-layer capability of the bundle manager module is changed. Only the system resource HAP supports custom permissions.
27
28**Adaptation Guide**<br>
29If an application requires custom permissions, add the permissions under the **definePermissions** field in the [configuration file](https://gitee.com/openharmony/utils_system_resources/blob/master/systemres/main/config.json) of the system resource HAP. For details about the permission format, see [Defining Permissions](../../../application-dev/quick-start/module-structure.md#internal-structure-of-the-definepermissions-attribute).
30
31## cl.bundlemanager.3 Level-2 Module File Names Changed
32
33The level-2 module file names of the bundle manager module are changed to their respective API names in the file, as listed below.
34
35| Original File Name|New File Name|
36|----|----|
37| bundleManager/abilityInfo.d.ts |  bundleManager/AbilityInfo.d.ts |
38| bundleManager/applicationInfo.d.ts |  bundleManager/ApplicationInfo.d.ts |
39| bundleManager/bundleInfo.d.ts |  bundleManager/BundleInfo.d.ts |
40| bundleManager/dispatchInfo.d.ts |  bundleManager/DispatchInfo.d.ts |
41| bundleManager/elementName.d.ts |  bundleManager/ElementName.d.ts |
42| bundleManager/extensionAbilityInfo.d.ts |  bundleManager/ExtensionAbilityInfo.d.ts |
43| bundleManager/hapModuleInfo.d.ts |  bundleManager/HapModuleInfo.d.ts |
44| bundleManager/launcherAbilityInfo.d.ts |  bundleManager/LauncherAbilityInfo.d.ts |
45| bundleManager/metadata.d.ts |  bundleManager/Metadata.d.ts |
46| bundleManager/packInfo.d.ts |  bundleManager/BundlePackInfo.d.ts |
47| bundleManager/permissionDef.d.ts |  bundleManager/PermissionDef.d.ts |
48| bundleManager/remoteAbilityInfo.d.ts |  bundleManager/RemoteAbilityInfo.d.ts |
49| bundleManager/shortcutInfo.d.ts |  bundleManager/ShortcutInfo.d.ts |
50
51To sum up, except **packInfo**, which is changed to **BundlePackInfo**, the other file names are changed to start with uppercase letters.
52
53**Change Impact**<br>
54The change of the level-2 module file names does not affect the use of the level-1 module. If a level-2 module interface under **bundleManager** is directly imported to the .ts file and an error is reported during compilation on DevEco Studio, you must change the name of the imported file.
55
56**Key API/Component Changes**<br>
57The .d.ts file names in the **bundleManager** folder are changed to their respective API names in the file.
58
59**Adaptation Guide**<br>
60Generally, no adaptation is required. If a file in the **bundleManager** folder is directly imported to the application, you must change the imported file name as follows:
61
62**Before change:**
63```ts
64import {AbilityInfo} from 'bundleManger/abilityInfo';
65import {ExtensionAbilityInfo} from 'bundleManger/extensionAbilityInfo';
66import {BundlePackInfo} from 'bundleManger/packInfo';
67```
68**After change:**
69```ts
70import {AbilityInfo} from 'bundleManger/AbilityInfo';
71import {ExtensionAbilityInfo} from 'bundleManger/ExtensionAbilityInfo';
72import {BundlePackInfo} from 'bundleManger/BundlePackInfo';
73```
74
75## cl.bundlemanager.4 LaunchType Enum Type Name Changed from STANDARD to MULTITON
76
77The enum type name of [LaunchType](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/@ohos.bundle.bundleManager.d.ts) is changed from **STANDARD** to **MULTITON**. The enum value remains unchanged, indicating the multi-instance type.
78
79**Change Impact**<br>
80The **LaunchType.STANDARD** type does not take effect.
81
82**Key API/Component Changes**<br>
83The enum type name of **LaunchType** is changed from **STANDARD** to **MULTITON**.
84
85**Adaptation Guide**<br>
86Change **LaunchType.STANDARD** to **LaunchType.MULTITON** for your application.
87
88## cl.bundlemanager.5 Changed the isVisible Field in the AbilityInfo Struct to exported
89
90The **isVisible** field in the [AbilityInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/AbilityInfo.d.ts) struct is changed to **exported**. The type remains unchanged, indicating whether the ability can be exported and used by other abilities.
91
92**Change Impact**<br>
93The **isVisible** field does not take effect.
94
95**Key API/Component Changes**<br>
96The **isVisible** field in the [AbilityInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/AbilityInfo.d.ts) struct is changed to **exported**, and the type remains unchanged.
97
98**Adaptation Guide**<br>
99Change **isVisible** to **exported** for your application.
100
101## cl.bundlemanager.6 Changed the isVisible Field in the ExtensionAbilityInfo Struct to exported
102
103The **isVisible** field in the [ExtensionAbilityInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/ExtensionAbilityInfo.d.ts) struct is changed to **exported**. The type remains unchanged, indicating whether the ability can be exported and used by other abilities.
104
105**Change Impact**<br>
106The **isVisible** field does not take effect.
107
108**Key API/Component Changes**<br>
109The **isVisible** field in the [ExtensionAbilityInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/ExtensionAbilityInfo.d.ts) struct is changed to **exported**, and the type remains unchanged.
110
111**Adaptation Guide**<br>
112Change **isVisible** to **exported** for your application.
113
114## cl.bundlemanager.7 Changed the visible Field in the ModuleAbilityInfo Struct to exported
115
116The **visible** field in the [ModuleAbilityInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/BundlePackInfo.d.ts) struct is changed to **exported**. The type remains unchanged, indicating whether the ability can be exported and used by other abilities.
117
118**Change Impact**<br>
119The **visible** field does not take effect.
120
121**Key API/Component Changes**<br>
122The **visible** field in the [ModuleAbilityInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/BundlePackInfo.d.ts) struct is changed to **exported**, and the type remains unchanged.
123
124**Adaptation Guide**<br>
125Change **visible** to **exported** for your application.
126
127## cl.bundlemanager.8 Deleted the distributedNotificationEnabled Tag from the app.json Configuration File
128The [distributedNotificationEnabled](../../../application-dev/quick-start/app-configuration-file.md) tag is deleted from the **app.json** configuration file.
129
130**Change Impact**<br>
131If this tag is used, an error is reported during compilation on DevEco Studio.
132
133**Adaptation Guide**<br>
134Delete this tag from the configuration file.
135
136## cl.bundlemanager.9 Deleted the entityType Tag from the app.json Configuration File
137The [entityType](../../../application-dev/quick-start/app-configuration-file.md) tag is deleted from the **app.json** configuration file.
138
139**Change Impact**<br>
140If this tag is used, an error is reported during compilation on DevEco Studio.
141
142**Adaptation Guide**<br>
143Delete this tag from the configuration file.
144
145## cl.bundlemanager.10 Deleted the keepAlive Tag from the app.json Configuration File
146The [keepAlive](../../../application-dev/quick-start/app-configuration-file.md) tag is deleted from the **app.json** configuration file.
147
148**Change Impact**<br>
149If this tag is used, an error is reported during compilation on DevEco Studio.
150
151**Adaptation Guide**<br>
152Delete this tag from the configuration file.
153
154## cl.bundlemanager.11 Deleted the removable Tag from the app.json Configuration File
155The [removable](../../../application-dev/quick-start/app-configuration-file.md) tag is deleted from the **app.json** configuration file.
156
157**Change Impact**<br>
158If this tag is used, an error is reported during compilation on DevEco Studio.
159
160**Adaptation Guide**<br>
161Delete this tag from the configuration file.
162
163## cl.bundlemanager.12 Deleted the singleton Tag from the app.json Configuration File
164The [singleton](../../../application-dev/quick-start/app-configuration-file.md) tag is deleted from the **app.json** configuration file.
165
166**Change Impact**<br>
167If this tag is used, an error is reported during compilation on DevEco Studio.
168
169**Adaptation Guide**<br>
170Delete this tag from the configuration file.
171
172## cl.bundlemanager.13 Deleted the userDataClearable Tag from the app.json Configuration File
173The [userDataClearable](../../../application-dev/quick-start/app-configuration-file.md) tag is deleted from the **app.json** configuration file.
174
175**Change Impact**<br>
176If this tag is used, an error is reported during compilation on DevEco Studio.
177
178**Adaptation Guide**<br>
179Delete this tag from the configuration file.
180
181## cl.bundlemanager.14 No Longer Chinese Characters for the name Tag under module in the module.json Configuration File
182The value of [name](../../../application-dev/quick-start/module-configuration-file.md) under **module** in the **module.json** configuration file does not support Chinese characters.
183
184**Change Impact**<br>
185If the tag is set to Chinese, an error is reported during compilation on DevEco Studio.
186
187**Adaptation Guide**<br>
188Set this tag to English.
189
190## cl.bundlemanager.15 No Longer Chinese Characters for the name Tag under ability in the module.json Configuration File
191The value of [name](../../../application-dev/quick-start/module-configuration-file.md) under **ability** in the **module.json** configuration file does not support Chinese characters.
192
193**Change Impact**<br>
194If the tag is set to Chinese, an error is reported during compilation on DevEco Studio.
195
196**Adaptation Guide**<br>
197Set this tag to English.
198
199## cl.bundlemanager.16 Deleted the uiSyntax Tag from the module.json Configuration File
200The [uiSyntax](../../../application-dev/quick-start/module-configuration-file.md) tag is deleted from the **module.json** configuration file.
201
202**Change Impact**<br>
203If this tag is used, an error is reported during compilation on DevEco Studio.
204
205**Adaptation Guide**<br>
206Delete this tag from the configuration file.
207
208## cl.bundlemanager.17 Changed srcEntrance to srcEntry in the module.json Configuration File
209The [srcEntrance](../../../application-dev/quick-start/module-configuration-file.md) tag under **module** and **ability** in the **module.json** configuration file is changed to **srcEntry**.
210
211**Change Impact**<br>
212If the **srcEntrance** tag is used, an error is reported during compilation on DevEco Studio.
213
214**Adaptation Guide**<br>
215Replace the **srcEntrance** tag with **srcEntry** in the configuration file.
216
217## cl.bundlemanager.18 Deleted the apiVersion Tag Under distroFilter from the module.json Configuration File
218The **apiVersion** tag under [distroFilter](../../../application-dev/quick-start/module-configuration-file.md) is deleted from the **module.json** configuration file.
219
220**Change Impact**<br>
221If this tag is used, an error is reported during compilation on DevEco Studio.
222
223**Adaptation Guide**<br>
224Delete this tag from the configuration file.
225
226## cl.bundlemanager.19 Changed distroFilter to distributionFilter in the module.json Configuration File
227The [distroFilter](../../../application-dev/quick-start/module-configuration-file.md) tag in the **module.json** configuration file is changed to **distributionFilter**.
228
229**Change Impact**<br>
230If the **distroFilter** tag is used, an error is reported during compilation on DevEco Studio.
231
232**Adaptation Guide**<br>
233Replace **distroFilter** with **distributionFilter** in the configuration file.
234
235## cl.bundlemanager.20 Changed standard of launchType to multiton in the module.json Configuration File
236The **standard** mode of the [launchType](../../../application-dev/quick-start/module-configuration-file.md) tag in the **module.json** file is changed to **multiton**.
237
238**Adaptation Guide**<br>
239Replace **standard** of **launchType** to **multiton** in the configuration file.
240
241## cl.bundlemanager.21 Deleted the atomicService Tag from the app.json File
242The **atomicService** tag is deleted from the **app.json** file.
243
244**Change Impact**<br>
245If this tag is used, an error is reported during compilation on DevEco Studio.
246
247**Adaptation Guide**<br>
248Delete the **atomicService** tag from your code.
249
250## cl.bundlemanager.22 Added the bundleType Tag to the app.json File
251The **bundleType** tag is added to the **app.json** file.
252
253**Change Impact**<br>
254For an existing ability with [installationFree](../../../application-dev/quick-start/module-configuration-file.md) set to **true**, **bundleType** must be set to **atomicService** in the **app.json** file. Otherwise, the packaging fails.
255
256**Adaptation Guide**<br>
257Add the [bundleType](../../../application-dev/quick-start/app-configuration-file.md) tag. This tag can be left blank. The default value is **app**. The setting of this tag and the [installationFree](../../../application-dev/quick-start/module-configuration-file.md) field in the **module.json** file must meet the following rules:
258- If **bundleType** is **app**, **installationFree** must be set to **false**.
259- If **bundleType** is **atomicService**, **installationFree** must be set to **true**.
260
261## cl.bundlemanager.23 Deleted the split Field from the ApplicationInfo Struct
262
263The **split** field is deleted from the [ApplicationInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/ApplicationInfo.d.ts) struct.
264
265**Change Impact**<br>
266If the **split** field is used in your code, the compilation fails.
267
268**Key API/Component Changes**<br>
269The **split** field is deleted from the [ApplicationInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/ApplicationInfo.d.ts) struct.
270
271**Adaptation Guide**<br>
272Delete the **split** field from the **ApplicationInfo** struct of your code. The stage model always forcibly splits bundles.
273
274## cl.bundlemanager.24 Deleted the atomicServiceModuleType Field from the HapModuleInfo Struct
275
276The **atomicServiceModuleType** field is deleted from the [HapModuleInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/HapModuleInfo.d.ts) struct.
277
278**Change Impact**<br>
279If the **atomicServiceModuleType** field is used in your code, the compilation fails.
280
281**Key API/Component Changes**<br>
282The **atomicServiceModuleType** field is deleted from the [HapModuleInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/HapModuleInfo.d.ts) struct.
283
284**Adaptation Guide**<br>
285Record the setting of the **atomicServiceModuleType** field, delete it from the [HapModuleInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/HapModuleInfo.d.ts) struct, and set the **moduleType** field in the [HapModuleInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/HapModuleInfo.d.ts) struct to the recorded value.
286
287## cl.bundlemanager.25 Deleted the AtomicServiceModuleType Enumerated Value
288
289The **atomicServiceModuleType** field is deleted from the [HapModuleInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/HapModuleInfo.d.ts) struct.
290
291**Change Impact**<br>
292If the **atomicServiceModuleType** field is used in your code, the compilation fails.
293
294**Key API/Component Changes**<br>
295The **atomicServiceModuleType** field is deleted from the [HapModuleInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/HapModuleInfo.d.ts) struct.
296
297**Adaptation Guide**<br>
298Record the setting of the **atomicServiceModuleType** field, delete it from the [HapModuleInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/HapModuleInfo.d.ts) struct, and set the **moduleType** field in the [HapModuleInfo](https://gitee.com/openharmony/interface_sdk-js/blob/master/api/bundleManager/HapModuleInfo.d.ts) struct to the recorded value.
299