@ohos.enterprise.bundleManager(包管理)


@ohos.enterprise.bundleManager(包管理)

本模块提供包管理能力,包括添加包安装白名单、获取包安装白名单、移除包安装白名单等。仅企业设备管理员应用才能调用。

说明:

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

导入模块

import bundleManager from '@ohos.enterprise.bundleManager';
1

bundleManager.addAllowedInstallBundles

addAllowedInstallBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void;

指定设备管理员应用添加包安装白名单接口,添加至白名单的应用允许在管理员用户下安装,否则不允许安装,使用callback形式返回是否添加成功。

需要权限: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数 类型 必填 说明
admin Want 设备管理员应用。
appIds Array<string> 允许安装包的白名单。
callback AsyncCallback<void> 回调函数。当接口调用成功,err为null,否则为错误对象。

错误码

以下的错误码的详细介绍请参见企业设备管理错误码

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200007 the system ability work abnormally.

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "EntryAbility",
};
let appIds = {"com.example.myapplication"};

bundleManager.AddAllowedInstallBundles(wantTemp, appIds, (error) => {
    if (error != null) {
        console.log("error code:" + error.code + " error message:" + error.message);
    }
});
1
2
3
4
5
6
7
8
9
10
11

bundleManager.addAllowedInstallBundles

addAllowedInstallBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void;

指定设备管理员应用添加包安装白名单接口,添加至白名单的应用允许在指定用户下安装,否则不允许安装,使用callback形式返回是否添加成功。

需要权限: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数 类型 必填 说明
admin Want 设备管理员应用。
appIds Array<string> 允许安装包的白名单。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。
callback AsyncCallback<void> 回调函数,当接口调用成功,err为null,否则为错误对象。

错误码

以下的错误码的详细介绍请参见企业设备管理错误码

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200007 the system ability work abnormally.

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "EntryAbility",
};
let appIds = {"com.example.myapplication"};

bundleManager.AddAllowedInstallBundles(wantTemp, appIds, 100, (error) => {
    if (error != null) {
        console.log("error code:" + error.code + " error message:" + error.message);
    }
});
1
2
3
4
5
6
7
8
9
10
11

bundleManager.addAllowedInstallBundles

addAllowedInstallBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>;

指定设备管理员应用添加包安装白名单接口,如果调用接口时传入了可选参数userId,则添加至白名单的应用允许在指定用户下安装,如果调用接口时没有传入参数userId,则添加至白名单的应用允许在当前用户下安装,使用promise形式返回是否添加成功。

需要权限: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数 类型 必填 说明
admin Want 设备管理员应用。
appIds Array<string> 允许安装包的白名单。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。当指定设备管理员应用添加包安装白名单失败时会抛出错误对象。

错误码

以下的错误码的详细介绍请参见企业设备管理错误码

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200007 the system ability work abnormally.

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "EntryAbility",
};
let appIds = {"com.example.myapplication"};

bundleManager.addAllowedInstallBundles(wantTemp, appIds, 100).then(() => {
    console.log("success");
}).catch(error => {
    console.log("error code:" + error.code + " error message:" + error.message);
});
1
2
3
4
5
6
7
8
9
10
11

bundleManager.removeAllowedInstallBundles

removeAllowedInstallBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void;

指定设备管理员应用移除包安装白名单接口,在白名单存在的情况下,不在包安装白名单中的应用不允许在当前用户下安装,使用callback形式返回移除结果。

需要权限: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数 类型 必填 说明
admin Want 设备管理员应用。
appIds Array<string> 移除允许安装包的白名单。
callback AsyncCallback<void> 回调函数。当接口调用成功,err为null,否则为错误对象。

错误码

以下的错误码的详细介绍请参见企业设备管理错误码

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200007 the system ability work abnormally.

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "EntryAbility",
};
let appIds = {"com.example.myapplication"};

bundleManager.removeAllowedInstallBundles(wantTemp, appIds, (error) => {
    if (error != null) {
        console.log("error code:" + error.code + " error message:" + error.message);
    }
});
1
2
3
4
5
6
7
8
9
10
11

bundleManager.removeAllowedInstallBundles

removeAllowedInstallBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void;

指定设备管理员应用移除包安装白名单接口,在白名单存在的情况下,不在包安装白名单中的应用不允许在指定用户下安装,使用callback形式返回移除结果。

需要权限: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数 类型 必填 说明
admin Want 设备管理员应用。
appIds Array<string> 允许安装包的白名单。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。
callback AsyncCallback<void> 回调函数。当接口调用成功,err为null,否则为错误对象。

错误码

以下的错误码的详细介绍请参见企业设备管理错误码

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200007 the system ability work abnormally.

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "EntryAbility",
};
let appIds = {"com.example.myapplication"};

bundleManager.removeAllowedInstallBundles(wantTemp, appIds, 100, (error) => {
    if (error != null) {
        console.log("error code:" + error.code + " error message:" + error.message);
    }
});
1
2
3
4
5
6
7
8
9
10
11

bundleManager.removeAllowedInstallBundles

removeAllowedInstallBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>;

指定设备管理员应用移除包安装白名单接口,在白名单存在的情况下,如果调用接口时传入参数userId,则不在包安装白名单中的应用不允许在指定用户下安装,如果调用接口时没有传入参数userId,则不在包安装白名单中的应用不允许在当前用户下安装,使用promise形式返回移除结果。

需要权限: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数 类型 必填 说明
admin Want 设备管理员应用。
appIds Array&lt;string> 允许安装包的白名单。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。当指定设备管理员应用移除包安装白名单失败时会抛出错误对象。

错误码

以下的错误码的详细介绍请参见企业设备管理错误码

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200007 the system ability work abnormally.

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "EntryAbility",
};
let appIds = {"com.example.myapplication"};

bundleManager.removeAllowedInstallBundles(wantTemp, appIds, 100).then(() => {
    console.log("success");
}).catch(error => {
    console.log("error code:" + error.code + " error message:" + error.message);
});
1
2
3
4
5
6
7
8
9
10
11

bundleManager.getAllowedInstallBundles

getAllowedInstallBundles(admin: Want, callback: AsyncCallback<Array<string>>): void;

指定管理员应用获取管理员用户下的包安装白名单接口,使用callback形式返回获取包安装白名单。

需要权限: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数 类型 必填 说明
admin Want 设备管理员应用。
callback AsyncCallback<Array<string>> 回调函数,当接口调用成功,err为null,否则为错误对象。

错误码

以下的错误码的详细介绍请参见企业设备管理错误码

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200007 the system ability work abnormally.

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "EntryAbility",
};

bundleManager.getAllowedInstallBundles(wantTemp, (error) => {
    if (error != null) {
        console.log("error code:" + error.code + " error message:" + error.message);
    }
});
1
2
3
4
5
6
7
8
9
10

bundleManager.getAllowedInstallBundles

getAllowedInstallBundles(admin: Want, userId: number, callback: AsyncCallback<Array<string>>): void;

指定管理员应用获取指定用户下的包安装白名单接口,使用callback形式返回获取包安装白名单。

需要权限: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数 类型 必填 说明
admin Want 设备管理员应用。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。
callback AsyncCallback<Array<string>> 回调函数,当接口调用成功,err为null,否则为错误对象。

错误码

以下的错误码的详细介绍请参见企业设备管理错误码

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200007 the system ability work abnormally.

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "EntryAbility",
};

bundleManager.getAllowedInstallBundles(wantTemp, 100, (error) => {
    if (error != null) {
        console.log("error code:" + error.code + " error message:" + error.message);
    }
});
1
2
3
4
5
6
7
8
9
10

bundleManager.getAllowedInstallBundles

getAllowedInstallBundles(admin: Want, userId?: number): Promise<Array<string>>;

指定管理员应用获取管理员用户下包安装白名单接口,使用promise形式返回获取包安装白名单。

需要权限: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数 类型 必填 说明
admin Want 设备管理员应用。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

返回值:

类型 说明
Promise<Array<string>> Promise对象,返回管理员用户下的包安装白名单。

错误码

以下的错误码的详细介绍请参见企业设备管理错误码

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200007 the system ability work abnormally.

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "EntryAbility",
};
bundleManager.getAllowedInstallBundles(wantTemp, 100).then(() => {
    console.log("success");
}).catch(error => {
    console.log("error code:" + error.code + " error message:" + error.message);
});
1
2
3
4
5
6
7
8
9