@ohos.bundle.bundleMonitor (bundleMonitor)

The Bundle.bundleMonitor module provides APIs for listens for bundle installation, uninstall, and updates.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import bundleMonitor from '@ohos.bundle.bundleMonitor';

Required Permissions

Permission	Permission Level	Description
ohos.permission.LISTEN_BUNDLE_CHANGE	system_basic	Permission to listen for bundle installation, uninstall, and updates.

For details, see Permission Levels.

BundleChangeInfo

System capability: SystemCapability.BundleManager.BundleFramework.Core

System API: This is a system API.

Name	Template	Readable	Writable	Description
bundleName	string	Yes	No	Name of the bundle whose status changes.
userId	number	Yes	No	ID of the user whose bundle status changes.

BundleChangedEvent

Enumerates the types of events to listen for.

System capability: SystemCapability.BundleManager.BundleFramework.Core

System API: This is a system API.

Name	Description
add	Bundle addition events.
update	Bundle update events.
remove	Bundle removal events.

bundleMonitor.on

on(type: BundleChangedEvent, callback: Callback<BundleChangedInfo>): void

Subscribes to bundle installation, uninstall, and update events.

NOTE

This API must be used together with bundleMonitor.off. When the lifecycle of a component, page, or application ends, use bundleMonitor.off to unsubscribe from the bundle installation, uninstall, and update events.

Required permissions: ohos.permission.LISTEN_BUNDLE_CHANGE

System API: This is a system API.

System capability: SystemCapability.BundleManager.BundleFramework.Core

Parameters

Name	Type	Mandatory	Description
type	BundleChangedEvent	Yes	Type of the event to subscribe to.
callback	callback<BundleChangedInfo>	Yes	Callback used for the subscription.

Example

import bundleMonitor from '@ohos.bundle.bundleMonitor';
import { BusinessError } from '@ohos.base';

try {
    bundleMonitor.on('add', (bundleChangeInfo) => {
        console.info(`bundleName : ${bundleChangeInfo.bundleName} userId : ${bundleChangeInfo.userId}`);
	})
} catch (errData) {
    let message = (errData as BusinessError).message;
    let errCode = (errData as BusinessError).code;
    console.log(`errData is errCode:${errCode}  message:${message}`);
}

bundleMonitor.off

off(type: BundleChangedEvent, callback?: Callback<BundleChangedInfo>): void

Unsubscribes from bundle installation, uninstall, and update events.

Required permissions: ohos.permission.LISTEN_BUNDLE_CHANGE

System API: This is a system API.

System capability: SystemCapability.BundleManager.BundleFramework.Core

Parameters

Name	Type	Mandatory	Description
type	BundleChangedEvent	Yes	Type of the event to unsubscribe from.
callback	callback<BundleChangedInfo>	No	Callback used for the unsubscription. By default, no value is passed, and all callbacks of the current event are unsubscribed from.

Example

import bundleMonitor from '@ohos.bundle.bundleMonitor';
import { BusinessError } from '@ohos.base';

try {
    bundleMonitor.off('add');
} catch (errData) {
    let message = (errData as BusinessError).message;
    let errCode = (errData as BusinessError).code;
    console.log(`errData is errCode:${errCode}  message:${message}`);
}