@ohos.bundle.freeInstall (freeInstall模块)


@ohos.bundle.freeInstall (freeInstall模块)

本模块提供免安装相关的设置和查询能力,支持BundlePackInfo、DispatchInfo等信息的查询

说明:

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

本模块接口为系统接口。

导入模块

import freeInstall from '@ohos.bundle.freeInstall';
1

权限列表

权限 权限等级 描述
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED system_basic 可查询所有应用信息。
ohos.permission.INSTALL_BUNDLE system_core 可安装、卸载应用。

权限等级参考权限等级说明

UpgradeFlag

系统接口: 此接口为系统接口。

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

名称 说明
NOT_UPGRADE 0 模块无需升级。
SINGLE_UPGRADE 1 单个模块需要升级。
RELATION_UPGRADE 2 关系模块需要升级。

BundlePackFlag

系统接口: 此接口为系统接口。

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

名称 说明
GET_PACK_INFO_ALL 0x00000000 获取应用包pack.info的所有信息。
GET_PACKAGES 0x00000001 获取应用包pack.info的package信息。
GET_BUNDLE_SUMMARY 0x00000002 获取应用包pack.info的bundle摘要信息。
GET_MODULE_SUMMARY 0x00000004 获取应用包pack.info的module摘要信息。

freeInstall.setHapModuleUpgradeFlag

setHapModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag, callback: AsyncCallback<void>):void;

设置指定模块是否升级。使用callback异步回调。

需要权限: ohos.permission.INSTALL_BUNDLE

系统接口: 此接口为系统接口。

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

参数:

参数名 类型 必填 说明
bundleName string 应用Bundle名称。
moduleName string 应用程序模块名称。
upgradeFlag UpgradeFlag 仅供内部系统使用标志位
callback AsyncCallback<void> 回调函数。当函数调用成功,err为null,否则为错误对象。

错误码:

以下错误码的详细介绍请参见ohos.bundle错误码

错误码ID 错误信息
17700001 The specified bundle name is not found.
17700002 The specified module name is not found.

示例:

import freeInstall from '@ohos.bundle.freeInstall';
let bundleName = 'com.example.myapplication';
let moduleName = 'entry';
let upgradeFlag = freeInstall.UpgradeFlag.SINGLE_UPGRADE;
try {
    freeInstall.setHapModuleUpgradeFlag(bundleName, moduleName, upgradeFlag, err => {
        if (err) {
            console.error('Operation failed:' + JSON.stringify(err));
        } else {
            console.info('Operation succeed');
        }
    });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

setHapModuleUpgradeFlag

setHapModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag): Promise<void>;

设置指定模块是否升级。使用Promise异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.INSTALL_BUNDLE

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

参数:

参数名 类型 必填 说明
bundleName string 应用Bundle名称。
moduleName string 应用程序模块名称。
upgradeFlag UpgradeFlag 仅供内部系统使用标志位。

返回值:

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

错误码:

以下错误码的详细介绍请参见ohos.bundle错误码

错误码ID 错误信息
17700001 The specified bundle name is not found.
17700002 The specified module name is not found.

示例:

import freeInstall from '@ohos.bundle.freeInstall';
let bundleName = 'com.example.myapplication';
let moduleName = 'entry';
let upgradeFlag = freeInstall.UpgradeFlag.SINGLE_UPGRADE;
try {
    freeInstall.setHapModuleUpgradeFlag(bundleName, moduleName, upgradeFlag).then(() => {
        console.info('Operation succeed')
    }).catch(err => {
        console.error('Operation failed:' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13

isHapModuleRemovable

isHapModuleRemovable(bundleName: string, moduleName: string, callback: AsyncCallback<boolean>): void;

查询指定模块是否可以被移除。使用callback异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

参数:

参数名 类型 必填 说明
bundleName string 应用Bundle名称。
moduleName string 应用程序模块名称。
callback AsyncCallback<boolean> 回调函数。返回true表示可以移除;返回false表示不可移除。

错误码:

以下错误码的详细介绍请参见ohos.bundle错误码

错误码ID 错误信息
17700001 The specified bundle name is not found.
17700002 The specified module name is not found.

示例:

import freeInstall from '@ohos.bundle.freeInstall';
let bundleName = 'com.example.myapplication';
let moduleName = 'entry';
try {
    freeInstall.isHapModuleRemovable(bundleName, moduleName, (err, data) => {
        if (err) {
            console.error('Operation failed:' + JSON.stringify(err));
        } else {
            console.info('Operation succeed:' + JSON.stringify(data));
        }
    });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

isHapModuleRemovable

isHapModuleRemovable(bundleName: string, moduleName: string): Promise<boolean>;

查询指定模块是否可以被移除。使用Promise异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

参数:

参数名 类型 必填 说明
bundleName string 应用Bundle名称。
moduleName string 应用程序模块名称。

返回值:

类型 说明
Promise<boolean> Promise对象。返回true表示可以移除;返回false表示不可移除。

错误码:

以下错误码的详细介绍请参见ohos.bundle错误码

错误码ID 错误信息
17700001 The specified bundle name is not found.
17700002 The specified module name is not found.

示例:

import freeInstall from '@ohos.bundle.freeInstall';
let bundleName = 'com.example.myapplication';
let moduleName = 'entry';
try {
    freeInstall.isHapModuleRemovable(bundleName, moduleName).then(data => {
        console.info('Operation succeed:' + JSON.stringify(data));
    }).catch(err => {
        console.error('Operation failed:' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getBundlePackInfo

getBundlePackInfo(bundleName: string, bundlePackFlag : BundlePackFlag, callback: AsyncCallback<BundlePackInfo>): void;

基于bundleName和bundlePackFlag来获取bundlePackInfo。使用callback异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

参数:

参数名 类型 必填 说明
bundleName string 应用Bundle名称。
bundlePackFlag BundlePackFlag 指示要查询的应用包标志。
callback AsyncCallback<BundlePackInfo> 回调函数。当函数调用成功,err为null,data为获取到的BundlePackInfo信息。否则为错误对象。

错误码:

以下错误码的详细介绍请参见ohos.bundle错误码

错误码ID 错误信息
17700001 The specified bundle name is not found.

示例:

import freeInstall from '@ohos.bundle.freeInstall';
let bundleName = 'com.example.myapplication';
let bundlePackFlag = freeInstall.BundlePackFlag.GET_PACK_INFO_ALL;
try {
    freeInstall.getBundlePackInfo(bundleName, bundlePackFlag, (err, data) => {
        if (err) {
            console.error('Operation failed:' + JSON.stringify(err));
        } else {
            console.info('Operation succeed:' + JSON.stringify(data));
        }
    });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

getBundlePackInfo

getBundlePackInfo(bundleName: string, bundlePackFlag : BundlePackFlag): Promise<BundlePackInfo>;

基于bundleName和bundleFlag来获取bundlePackInfo。使用Promise异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

参数:

参数名 类型 必填 说明
bundleName string 应用程序Bundle名称。
bundlePackFlag BundlePackFlag 指示要查询的应用包标志。

返回值:

类型 说明
Promise<BundlePackInfo> Promise对象,返回BundlePackInfo信息。

错误码:

以下错误码的详细介绍请参见ohos.bundle错误码

错误码ID 错误信息
17700001 The specified bundle name is not found.

示例:

import freeInstall from '@ohos.bundle.freeInstall';
let bundleName = 'com.example.myapplication';
let bundlePackFlag = freeInstall.BundlePackFlag.GET_PACK_INFO_ALL;
try {
    freeInstall.getBundlePackInfo(bundleName, bundlePackFlag).then(data => {
        console.info('Operation succeed:' + JSON.stringify(data));
    }).catch(err => {
        console.error('Operation failed:' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getDispatchInfo

getDispatchInfo(callback: AsyncCallback<DispatchInfo>): void;

获取有关dispatch版本的信息。使用callback异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

参数:

参数名 类型 必填 说明
callback AsyncCallback<DispatchInfo> 回调函数。当函数调用成功,err为null,data为获取到的DispatchInfo信息。否则为错误对象。

示例:

import freeInstall from '@ohos.bundle.freeInstall';
try {
    freeInstall.getDispatchInfo((err, data) => {
        if (err) {
            console.error('Operation failed:' + JSON.stringify(err));
        } else {
            console.info('Operation succeed:' + JSON.stringify(data));
        }
    });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getDispatchInfo

getDispatchInfo(): Promise<DispatchInfo>;

获取有关dispatch版本的信息。使用Promise异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力: SystemCapability.BundleManager.BundleFramework.FreeInstall

返回值:

类型 说明
Promise<DispatchInfo> Promise对象,返回DispatchInfo信息。

示例:

import freeInstall from '@ohos.bundle.freeInstall';
try {
    freeInstall.getDispatchInfo().then(data => {
        console.info('Operation succeed:' + JSON.stringify(data));
    }).catch(err => {
        console.error('Operation failed:' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10