harmony 鸿蒙@ohos.enterprise.applicationManager（应用管理）

2023-06-24
浏览 (566)

@ohos.enterprise.applicationManager（应用管理）

本模块提供应用管理能力，包括添加应用运行黑名单、获取应用运行黑名单、移除应用运行黑名单等。

说明：

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

本模块接口仅可在Stage模型下使用。

本模块接口仅对设备管理应用开放，需将设备管理应用激活后调用，实现相应功能。

导入模块

import applicationManager from '@ohos.enterprise.applicationManager';

applicationManager.addDisallowedRunningBundles

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

指定设备管理应用添加应用至应用运行黑名单，添加至黑名单的应用不允许在当前用户下运行，否则允许运行。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

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

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appIds	Array<string>	是	应用ID数组，指定具体应用。
callback	AsyncCallback<void>	是	回调函数。当接口调用成功，err为null，否则为错误对象。

错误码：

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

|错误码ID|错误信息 |
|——-|—————————————————————————-| |9200001|the application is not an administrator of the device. | |9200002|the administrator application does not have permission to manage the device.|

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];

applicationManager.addDisallowedRunningBundles(wantTemp, appIds, (err) => {
  if (err) {
    console.error(`Failed to add disallowed running bundles. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('Succeeded in adding disallowed running bundles');
});

applicationManager.addDisallowedRunningBundles

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

指定设备管理应用添加应用至应用运行黑名单，添加至黑名单的应用不允许在指定用户（通过userId指定）下运行，否则允许运行。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

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

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appIds	Array<string>	是	应用ID数组，指定具体应用。
userId	number	是	用户ID，指定具体用户。取值范围：大于等于0。
callback	AsyncCallback<void>	是	回调函数，当接口调用成功，err为null，否则为错误对象。

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];

applicationManager.addDisallowedRunningBundles(wantTemp, appIds, 100, (err) => {
  if (err) {
    console.error(`Failed to add disallowed running bundles. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('Succeeded in adding disallowed running bundles');
});

applicationManager.addDisallowedRunningBundles

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

指定设备管理应用添加应用至应用运行黑名单，添加至黑名单的应用不允许在当前/指定用户下运行。使用promise异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

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

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appIds	Array<string>	是	应用ID数组，指定具体应用。
userId	number	否	用户ID，取值范围：大于等于0。 - 调用接口时，若传入userId，表示指定用户。 - 调用接口时，若未传入userId，表示当前用户。

返回值：

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

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];

applicationManager.addDisallowedRunningBundles(wantTemp, appIds, 100).then(() => {
  console.info('Succeeded in adding disallowed running bundles');
}).catch((err: BusinessError) => {
  console.error(`Failed to add disallowed running bundles. Code is ${err.code}, message is ${err.message}`);
});

applicationManager.removeDisallowedRunningBundles

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

指定设备管理应用在应用运行黑名单中移除应用，在黑名单存在的情况下，在应用运行黑名单中的应用不允许在当前用户下运行。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

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

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appIds	Array<string>	是	应用ID数组，指定具体应用。
callback	AsyncCallback<void>	是	回调函数。当接口调用成功，err为null，否则为错误对象。

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];

applicationManager.removeDisallowedRunningBundles(wantTemp, appIds, (err) => {
  if (err) {
    console.error(`Failed to remove disallowed running bundles. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('Succeeded in removing disallowed running bundles');
});

applicationManager.removeDisallowedRunningBundles

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

指定设备管理应用在应用运行黑名单中移除应用，在黑名单存在的情况下，在应用运行黑名单中的应用不允许在指定用户（通过userId指定）下运行。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

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

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appIds	Array<string>	是	应用ID数组，指定具体应用。
userId	number	是	用户ID，指定具体用户。取值范围：大于等于0。
callback	AsyncCallback<void>	是	回调函数。当接口调用成功，err为null，否则为错误对象。

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];

applicationManager.removeDisallowedRunningBundles(wantTemp, appIds, 100, (err) => {
  if (err) {
    console.error(`Failed to remove disallowed running bundles. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('Succeeded in removing disallowed running bundles');
});

applicationManager.removeDisallowedRunningBundles

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

指定当前/指定用户下的设备管理应用在应用运行黑名单中移除应用，使用promise异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

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

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appIds	Array<string>	是	应用ID数组，指定具体应用。
userId	number	否	用户ID，取值范围：大于等于0。 - 调用接口时，若传入userId，表示指定用户。 - 调用接口时，若未传入userId，表示当前用户。

返回值：

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

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];

applicationManager.removeDisallowedRunningBundles(wantTemp, appIds, 100).then(() => {
  console.info('Succeeded in removing disallowed running bundles');
}).catch((err: BusinessError) => {
  console.error(`Failed to remove disallowed running bundles. Code is ${err.code}, message is ${err.message}`);
});

applicationManager.getDisallowedRunningBundles

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

指定设备管理应用获取当前用户下的应用运行黑名单。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

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

参数：

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

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

applicationManager.getDisallowedRunningBundles(wantTemp, (err, result) => {
  if (err) {
    console.error(`Failed to get disallowed running bundles. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in getting disallowed running bundles, result : ${JSON.stringify(result)}`);
});

applicationManager.getDisallowedRunningBundles

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

指定设备管理应用获取指定用户（通过userId指定）下的应用运行黑名单。使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

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

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
userId	number	是	用户ID，指定具体用户。取值范围：大于等于0。
callback	AsyncCallback<Array<string>>	是	回调函数，当接口调用成功，err为null，否则为错误对象。

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

applicationManager.getDisallowedRunningBundles(wantTemp, 100, (err, result) => {
  if (err) {
    console.error(`Failed to get disallowed running bundles. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in getting disallowed running bundles, result : ${JSON.stringify(result)}`);
});

applicationManager.getDisallowedRunningBundles

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

指定设备管理应用获取当前/指定用户下的应用运行黑名单，使用promise异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

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

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
userId	number	否	用户ID，取值范围：大于等于0。 - 调用接口时，若传入userId，表示指定用户。 - 调用接口时，若未传入userId，表示当前用户。

返回值：

类型	说明
Promise<Array<string>>	Promise对象，返回当前用户下的应用运行黑名单。

错误码：

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

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

applicationManager.getDisallowedRunningBundles(wantTemp, 100).then((result) => {
  console.info(`Succeeded in getting disallowed running bundles, result : ${JSON.stringify(result)}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get disallowed running bundles. Code is ${err.code}, message is ${err.message}`);
});