harmony(鸿蒙)appControl模块

  • 2022-11-09
  • 浏览 (452)

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

系统API: 此接口为系统接口,三方应用不支持调用。

参数:

名称 类型 必填 描述
appId string 需要设置处置状态的应用的appId。
appId是应用的唯一标识,由应用的包名和签名信息决定,可以通过getBundleInfo接口获取。
disposedWant Want 对应用的处置意图。

返回值:

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

错误码

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

错误码 错误信息
17700005 The specified appId was not found.

示例:

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

// 获取appId
var bundleName = 'com.example.myapplication';
var appId;
try {
    bundleManager.getBundleInfo(bundleName, BundleManager.BundleFlags.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO)
        .then((data) => {
            appId = data.signatureInfo.appId;
        }, error => {
            console.error("getBundleInfo failed " + error.message);
        });
} catch (error) {
    console.error("getBundleInfo failed " + error.message);
}

var want = {bundleName: 'com.example.myapplication'};

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

appControl.setDisposedStatus

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

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

需要权限: ohos.permission.MANAGE_DISPOSED_APP_STATUS

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

系统API: 此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
appId string 需要设置处置的应用的appId
appId是应用的唯一标识,由应用的包名和签名信息决定,可以通过getBundleInfo接口获取。
disposedWant Want 对应用的处置意图。
callback AsyncCallback<void> 回调函数,当设置处置状态成功,err为undefined,否则为错误对象。

错误码

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

错误码 错误信息
17700005 The specified appId was not found.

示例:

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

// 获取appId
var bundleName = 'com.example.myapplication';
var appId;
try {
    bundleManager.getBundleInfo(bundleName, BundleManager.BundleFlags.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO)
        .then((data) => {
            appId = data.signatureInfo.appId;
        }, error => {
            console.error("getBundleInfo failed " + error.message);
        });
} catch (error) {
    console.error("getBundleInfo failed " + error.message);
}

var want = {bundleName: 'com.example.myapplication'};

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

appControl.getDisposedStatus

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

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

需要权限: ohos.permission.MANAGE_DISPOSED_APP_STATUS

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

系统API: 此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
appId string 要查询的应用的appId
appId是应用的唯一标识,由应用的包名和签名信息决定,可以通过getBundleInfo接口获取。

返回值:

类型 说明
Promise<Want> Promise对象,返回应用的处置状态。

错误码

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

错误码 错误信息
17700005 The specified appId was not found.

示例:

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

// 获取appId
var bundleName = 'com.example.myapplication';
var appId;
try {
    bundleManager.getBundleInfo(bundleName, BundleManager.BundleFlags.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO)
        .then((data) => {
            appId = data.signatureInfo.appId;
        }, error => {
            console.error("getBundleInfo failed " + error.message);
        });
} catch (error) {
    console.error("getBundleInfo failed " + error.message);
}

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

appControl.getDisposedStatus

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

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

需要权限: ohos.permission.MANAGE_DISPOSED_APP_STATUS

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

系统API: 此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
appId string 要查询的应用的appId
appId是应用的唯一标识,由应用的包名和签名信息决定,可以通过getBundleInfo接口获取。
callback AsyncCallback<Want> 回调函数。当获取应用的处置状态成功时,err为undefined,data为获取到的处置状态;否则为错误对象。

错误码

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

错误码 错误信息
17700005 The specified appId was not found.

示例:

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

// 获取appId
var bundleName = 'com.example.myapplication';
var appId;
try {
    bundleManager.getBundleInfo(bundleName, BundleManager.BundleFlags.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO)
        .then((data) => {
            appId = data.signatureInfo.appId;
        }, error => {
            console.error("getBundleInfo failed " + error.message);
        });
} catch (error) {
    console.error("getBundleInfo failed " + error.message);
}

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

appControl.deleteDisposedStatus

deleteDisposedStatus(appId: string): Promise<void>

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

需要权限: ohos.permission.MANAGE_DISPOSED_APP_STATUS

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

系统API: 此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
appId string 要删除处置状态的应用的appId
appId是应用的唯一标识,由应用的包名和签名信息决定,可以通过getBundleInfo接口获取。

返回值:

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

错误码

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

错误码 错误信息
17700005 The specified appId was not found.

示例:

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

// 获取appId
var bundleName = 'com.example.myapplication';
var appId;
try {
    bundleManager.getBundleInfo(bundleName, BundleManager.BundleFlags.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO)
        .then((data) => {
            appId = data.signatureInfo.appId;
        }, error => {
            console.error("getBundleInfo failed " + error.message);
        });
} catch (error) {
    console.error("getBundleInfo failed " + error.message);
}

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

appControl.deleteDisposedStatus

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

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

需要权限: ohos.permission.MANAGE_DISPOSED_APP_STATUS

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

系统API: 此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
appId string 要查询的应用的appId。
appId是应用的唯一标识,由应用的包名和签名信息决定,可以通过getBundleInfo接口获取。
callback AsyncCallback<void> 回调函数,当设置处置状态成功时,err返回undefined。否则回调函数返回具体错误对象。

错误码

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

错误码 错误信息
17700005 The specified appId was not found.

示例:

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

// 获取appId
var bundleName = 'com.example.myapplication';
var appId;
try {
    bundleManager.getBundleInfo(bundleName, BundleManager.BundleFlags.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO)
        .then((data) => {
            appId = data.signatureInfo.appId;
        }, error => {
            console.error("getBundleInfo failed " + error.message);
        });
} catch (error) {
    console.error("getBundleInfo failed " + error.message);
}

try {
    appControl.deleteDisposedStatus(appId, (err, data) => {
        if (err) {
            console.error('deleteDisposedStatus failed ' + error.message);
            return;
        }
        console.info('deleteDisposedStatus success');
    });
} catch (error) {
    console.error('deleteDisposedStatus failed ' + error.message);
}

你可能感兴趣的鸿蒙文章

harmony(鸿蒙)接口

harmony(鸿蒙)开发说明

harmony(鸿蒙)BundleStatusCallback

harmony(鸿蒙)innerBundleManager模块(JS端SDK接口)

harmony(鸿蒙)distributedBundle模块(JS端SDK接口)

harmony(鸿蒙)Bundle模块(JS端SDK接口)

harmony(鸿蒙)Context模块

harmony(鸿蒙)DataUriUtils模块

harmony(鸿蒙)EnterpriseAdminExtensionAbility

harmony(鸿蒙)延迟任务调度回调

0  赞