@ohos.bundle.appControl (appControl模块)(系统接口)

本模块提供应用拦截能力。对应用设置处置状态后，应用会被禁止运行；用户点击桌面图标时，会根据应用的处置状态，跳转到对应的页面。本模块支持对应用的处置状态进行设置、获取、删除。

说明：

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

本模块为系统接口。

导入模块

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

appControl.setDisposedStatus

setDisposedStatus(appId: string, disposedWant: Want): Promise<void>

设置应用的处置状态。使用Promise异步回调。成功返回null，失败返回对应错误信息。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
import Want from '@ohos.app.ability.Want';
import appControl from '@ohos.bundle.appControl';

let appId = "com.example.myapplication_xxxxx";
let want:Want = {bundleName: 'com.example.myapplication'};

try {
    appControl.setDisposedStatus(appId, want)
        .then(() => {
            console.info('setDisposedStatus success');
        }).catch((error: BusinessError) => {
            let message = (error as BusinessError).message;
            console.error('setDisposedStatus failed ' + message);
        });
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('setDisposedStatus failed ' + message);
}

appControl.setDisposedStatus

setDisposedStatus(appId: string, disposedWant: Want, callback: AsyncCallback<void>): void;

设置应用的处置状态。使用callback异步回调。成功返回null，失败返回对应错误信息。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

错误码：

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

示例：

import appControl from '@ohos.bundle.appControl';
import { BusinessError } from '@ohos.base';
import Want from '@ohos.app.ability.Want';

let appId = "com.example.myapplication_xxxxx";
let want: Want = {bundleName: 'com.example.myapplication'};

try {
  appControl.setDisposedStatus(appId, want, (error: BusinessError, data) => {
    if (error) {
      let message = (error as BusinessError).message;
      console.error('setDisposedStatus failed ' + message);
      return;
    }
    console.info('setDisposedStatus success');
  });
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('setDisposedStatus failed ' + message);
}

appControl.setDisposedStatusSync¹⁰⁺

setDisposedStatusSync(appId: string, disposedWant: Want): void;

以同步方法设置应用的处置状态。成功返回null，失败抛出对应异常。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

错误码：

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

示例：

import appControl from '@ohos.bundle.appControl';
import { BusinessError } from '@ohos.base';
import Want from '@ohos.app.ability.Want';

let appId: string = "com.example.myapplication_xxxxx";
let want: Want = {bundleName: 'com.example.myapplication'};

try {
  appControl.setDisposedStatusSync(appId, want);
} catch (error) {
  let message = (error as BusinessError).message;
  console.error('setDisposedStatusSync failed ' + message);
}

appControl.getDisposedStatus

getDisposedStatus(appId: string): Promise<Want>;

获取指定应用已设置的处置状态。使用Promise异步回调，成功返回应用的处置状态，失败返回对应错误信息。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

返回值：

错误码：

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

示例：

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

let appId = "com.example.myapplication_xxxxx";

try {
  appControl.getDisposedStatus(appId)
    .then((data) => {
      console.info('getDisposedStatus success. DisposedStatus: ' + JSON.stringify(data));
    }).catch((error: BusinessError) => {
    let message = (error as BusinessError).message;
    console.error('getDisposedStatus failed ' + message);
  });
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('getDisposedStatus failed ' + message);
}

appControl.getDisposedStatus

getDisposedStatus(appId: string, callback: AsyncCallback<Want>): void;

获取指定应用的处置状态。使用callback异步回调，成功返回应用的处置状态，失败返回对应错误信息。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

错误码：

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

示例：

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

let appId = "com.example.myapplication_xxxxx";

try {
  appControl.getDisposedStatus(appId, (error, data) => {
    if (error) {
      let message = (error as BusinessError).message;
      console.error('getDisposedStatus failed ' + message);
      return;
    }
    console.info('getDisposedStatus success. DisposedStatus: ' + JSON.stringify(data));
  });
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('getDisposedStatus failed ' + message);
}

appControl.getDisposedStatusSync¹⁰⁺

getDisposedStatusSync(appId: string): Want;

以同步方法获取指定应用已设置的处置状态。成功返回应用的处置状态，失败抛出对应异常。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

返回值：

错误码：

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

示例：

import appControl from '@ohos.bundle.appControl';
import { BusinessError } from '@ohos.base';
import Want from '@ohos.app.ability.Want';

let appId: string = "com.example.myapplication_xxxxx";
let want: Want;

try {
    want = appControl.getDisposedStatusSync(appId);
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('getDisposedStatusSync failed ' + message);
}

appControl.deleteDisposedStatus

deleteDisposedStatus(appId: string): Promise<void>

删除应用的处置状态。使用promise异步回调，成功返回null，失败返回对应错误信息。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

返回值：

错误码：

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

示例：

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

let appId = "com.example.myapplication_xxxxx";

try {
  appControl.deleteDisposedStatus(appId)
    .then(() => {
      console.info('deleteDisposedStatus success');
    }).catch((error: BusinessError) => {
      let message = (error as BusinessError).message;
      console.error('deleteDisposedStatus failed ' + message);
  });
} catch (error) {
  let message = (error as BusinessError).message;
  console.error('deleteDisposedStatus failed ' + message);
}

appControl.deleteDisposedStatus

deleteDisposedStatus(appId: string, callback: AsyncCallback<void>) : void

删除应用的处置状态。使用callback异步回调，成功返回null，失败返回对应错误信息。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

错误码：

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

示例：

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

let appId = "com.example.myapplication_xxxxx";
try {
  appControl.deleteDisposedStatus(appId, (error: BusinessError, data) => {
    if (error) {
      console.error('deleteDisposedStatus failed ' + error.message);
      return;
    }
    console.info('deleteDisposedStatus success');
  });
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('deleteDisposedStatus failed ' + message);
}

appControl.deleteDisposedStatusSync¹⁰⁺

deleteDisposedStatusSync(appId: string, appIndex:? number) : void

以同步方法删除指定应用或分身应用的处置状态。成功返回null，失败抛出对应异常。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

错误码：

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

示例：

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

let appId: string = "com.example.myapplication_xxxxx";

try {
    appControl.deleteDisposedStatusSync(appId, 1);
} catch (error) {
    let message = (error as BusinessError).message;
    console.error('deleteDisposedStatusSync failed ' + message);
}

获取应用的appId和appIdentifier

appId是应用的唯一标识，由应用Bundle名称和签名信息决定，可以通过getBundleInfo接口获取。
appIdentifier也是应用的唯一标识，是AppGallery Connect创建应用时分配的APP ID，为云端统一分配的随机字符串。该ID在应用全生命周期中不会发生变化，包括版本升级、证书变更、开发者公私钥变更、应用转移等。

示例：

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

let bundleName = 'com.example.myapplication';
let appId: string;
let appIdentifier: string;
try {
  bundleManager.getBundleInfo(bundleName, bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO)
    .then((data) => {
      appId = data.signatureInfo.appId;
      appIdentifier = data.signatureInfo.appIdentifier;
      console.info("appId is " + appId);
      console.info("appIdentifier is " + appIdentifier);
    }).catch((error: BusinessError) => {
      let message = (error as BusinessError).message;
      console.error("getBundleInfo failed " + message);
  });
} catch (error) {
    let message = (error as BusinessError).message;
    console.error("getBundleInfo failed " + message);
}

appControl.getDisposedRule¹¹⁺

getDisposedRule(appId: string, appIndex:? number): DisposedRule

获取指定应用或分身应用已设置的拦截规则。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

返回值：

错误码：

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

示例：

import appControl from '@ohos.bundle.appControl';
import { BusinessError } from '@ohos.base';
import Want from '@ohos.app.ability.Want';

let appId = "com.example.myapplication_xxxxx";

try {
  let data = appControl.getDisposedRule(appId, 1);
  console.info('getDisposedRule successfully. Data: ' + JSON.stringify(data));
} catch (error) {
  let message = (error as BusinessError).message;
  console.error('getDisposedRule failed ' + message);
}

appControl.setDisposedRule¹¹⁺

setDisposedRule(appId: string, rule: DisposedRule, appIndex:? number): void

设置指定应用或分身应用的拦截规则。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

错误码：

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

示例：

import appControl from '@ohos.bundle.appControl';
import { BusinessError } from '@ohos.base';
import Want from '@ohos.app.ability.Want';
import bundleManager from '@ohos.bundle.bundleManager';

let appId = "com.example.myapplication_xxxxx";
let want: Want = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  abilityName: "EntryAbility"
};
let elementName: bundleManager.ElementName = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  abilityName: "EntryAbility"
};
let rule: appControl.DisposedRule = {
  want: want,
  componentType: appControl.ComponentType.UI_ABILITY,
  disposedType: appControl.DisposedType.BLOCK_APPLICATION,
  controlType: appControl.ControlType.ALLOWED_LIST,
  elementList: [
    elementName
  ],
  priority: 100
};

try {
  appControl.setDisposedRule(appId, rule, 1);
} catch (error) {
  let message = (error as BusinessError).message;
  console.error('setDisposedRule failed ' + message);
}

appControl.setDisposedRules²⁰⁺

setDisposedRules(disposedRuleConfigurations: Array<DisposedRuleConfiguration>): void

批量设置指定应用或分身应用的拦截规则。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { appControl, Want, bundleManager } from '@kit.AbilityKit';

let want: Want = {
  bundleName: 'com.example.myapplication',
  moduleName: 'entry',
  abilityName: 'EntryAbility'
};
let elementName: bundleManager.ElementName = {
  bundleName: 'com.example.myapplication',
  moduleName: 'entry',
  abilityName: 'EntryAbility'
};
let rule: appControl.DisposedRule = {
  want: want,
  componentType: appControl.ComponentType.UI_ABILITY,
  disposedType: appControl.DisposedType.BLOCK_APPLICATION,
  controlType: appControl.ControlType.ALLOWED_LIST,
  elementList: [
    elementName
  ],
  priority: 100
};

let disposedRuleConfiguration: appControl.DisposedRuleConfiguration = {
  appId: 'com.example.myapplication_BInGTMPMdc6v55s/UFIJHL5NLREXjOuxm/DsyMhlFmLAZC9/Gk+ruqS9OZr/dvFuaIaQQL1pKolvzK/zYNHvJ/I=',
  appIndex: 0,
  disposedRule: rule,
};

let disposedRuleConfigurations: Array<appControl.DisposedRuleConfiguration> = [];
disposedRuleConfigurations.push(disposedRuleConfiguration);
@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        Button('setDisposedRules', { type: ButtonType.Normal })
          .onClick(() => {
            try {
              appControl.setDisposedRules(disposedRuleConfigurations);
            } catch (error) {
              let message = (error as BusinessError).message;
              console.error('setDisposedRules failed ' + message);
            }
          });
      }
    }
  }
}

appControl.setUninstallDisposedRule¹⁵⁺

setUninstallDisposedRule(appIdentifier: string, rule: UninstallDisposedRule, appIndex:? number): void

设置指定应用或分身应用的卸载处置规则。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

错误码：

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

示例：

import appControl from '@ohos.bundle.appControl';
import { BusinessError } from '@ohos.base';
import Want from '@ohos.app.ability.Want';

let appIdentifier = "com.example.myapplication_xxxxx";
let want: Want = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  abilityName: "EntryAbility"
};
let rule: appControl.UninstallDisposedRule = {
  want: want,
  uninstallComponentType: appControl.UninstallComponentType.EXTENSION,
  priority: 100
};

try {
  appControl.setUninstallDisposedRule(appIdentifier, rule, 1);
} catch (error) {
  let message = (error as BusinessError).message;
  console.error('setUninstallDisposedRule failed ' + message);
}

appControl.getUninstallDisposedRule¹⁵⁺

getUninstallDisposedRule(appIdentifier: string, appIndex:? number): UninstallDisposedRule

获取指定应用或分身应用已设置的卸载处置规则。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS 或 ohos.permission.GET_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

返回值：

错误码：

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

示例：

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

let appIdentifier = "com.example.myapplication_xxxxx";

try {
  let data = appControl.getUninstallDisposedRule(appIdentifier, 1);
  console.info('getUninstallDisposedRule successfully. Data: ' + JSON.stringify(data));
} catch (error) {
  let message = (error as BusinessError).message;
  console.error('getUninstallDisposedRule failed ' + message);
}

appControl.deleteUninstallDisposedRule¹⁵⁺

deleteUninstallDisposedRule(appIdentifier: string, appIndex:? number): void

删除指定应用或分身应用的卸载处置规则。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.MANAGE_DISPOSED_APP_STATUS

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

参数：

错误码：

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

示例：

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

let appIdentifier = "com.example.myapplication_xxxxx";

try {
  appControl.deleteUninstallDisposedRule(appIdentifier, 1);
} catch (error) {
  let message = (error as BusinessError).message;
  console.error('deleteUninstallDisposedRule failed ' + message);
}

DisposedRule¹¹⁺

标识拦截规则。

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl。

系统接口： 此接口为系统接口。

ComponentType¹¹⁺

标识功能组件类型。

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl。

系统接口： 此接口为系统接口。

DisposedType¹¹⁺

标识拦截应用程序的方式，例如禁用应用的全部能力、禁用应用的指定能力、或者不禁用。

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl。

系统接口： 此接口为系统接口。

ControlType¹¹⁺

标识拦截指定应用程序的不同策略。

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl。

系统接口： 此接口为系统接口。

UninstallDisposedRule¹⁵⁺

标识卸载处置规则。

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl。

系统接口： 此接口为系统接口。

UninstallComponentType¹⁵⁺

标识卸载时功能组件类型。

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl。

系统接口： 此接口为系统接口。

DisposedRuleConfiguration²⁰⁺

标识批量设置拦截规则的配置。

系统能力： SystemCapability.BundleManager.BundleFramework.AppControl

系统接口： 此接口为系统接口。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Ability Kit（程序框架服务）

harmony 鸿蒙AbilityBase

harmony 鸿蒙AbilityBase_Element

harmony 鸿蒙AbilityRuntime

harmony 鸿蒙bundle

harmony 鸿蒙OH_NativeBundle_ApplicationInfo

harmony 鸿蒙OH_NativeBundle_ElementName

harmony 鸿蒙ability_base_common.h

harmony 鸿蒙ability_runtime_common.h

harmony 鸿蒙application_context.h