@ohos.bundle.appControl (appControl) (System API)

The appControl module provides APIs for setting, obtaining, and deleting the disposed status of an application. An application in the disposed status is forbidden to run. When a user clicks the application icon on the home screen, the corresponding page is displayed based on the disposal intent.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs provided by this module are system APIs.

Modules to Import

import appControl from '@ohos.bundle.appControl'

appControl.setDisposedStatus

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

Sets the disposed status for an application. This API uses a promise to return the result. If the operation is successful, null is returned. If the operation fails, an error message is returned.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.
disposedWant	Want	Yes	Disposal intent of the application.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.

Example

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;

Sets the disposed status for an application. This API uses an asynchronous callback to return the result. If the operation is successful, null is returned. If the operation fails, an error message is returned.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.
disposedWant	Want	Yes	Disposal intent of the application.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is null; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.

Example

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;

Sets the disposed status for an application. This API returns the result synchronously. If the operation is successful, null is returned. If the operation fails, an error message is returned.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.
disposedWant	Want	Yes	Disposal intent of the application.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.

Example

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>;

Obtains the disposed status of an application. This API uses a promise to return the result. If the operation is successful, the disposed status of the application is returned. If the operation fails, an error message is returned.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.

Return value

Type	Description
Promise<Want>	Promise used to return the disposed status.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.

Example

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;

Obtains the disposed status of an application. This API uses an asynchronous callback to return the result. If the operation is successful, the disposed status of the application is returned. If the operation fails, an error message is returned.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.
callback	AsyncCallback<Want>	Yes	Callback used to return the result. If the operation is successful, err is null and data is the disposed status obtained; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.

Example

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;

Obtains the disposed status of an application. This API returns the result synchronously. If the operation is successful, the disposed status of the application is returned. If the operation fails, an error message is returned.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.

Return value

Type	Description
Want	Disposed status.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.

Example

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>

Deletes the disposed status for an application. This API uses a promise to return the result. If the operation is successful, null is returned. If the operation fails, an error message is returned.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.

Example

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

Deletes the disposed status for an application. This API uses an asynchronous callback to return the result. If the operation is successful, null is returned. If the operation fails, an error message is returned.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is null; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.

Example

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

Deletes the disposed status for an application or an application clone. This API returns the result synchronously. If the operation is successful, null is returned. If the operation fails, an error message is returned.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.
appIndex	number	No	Index of the application clone. If this parameter is set to 0, the API is used to delete the disposed status of the application.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.
17700061	AppIndex is not in the valid range.

Example

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);
}

Obtaining appId of an Application

appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. It can be obtained by calling getBundleInfo.

Example

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

let bundleName = 'com.example.myapplication';
let appId: string;
try {
  bundleManager.getBundleInfo(bundleName, bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO)
    .then((data) => {
      appId = data.signatureInfo.appId;
      console.info("appId is " + appId);
    }).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

Obtains the disposed rule of an application or an application clone.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.
appIndex	number	No	Index of the application clone. If this parameter is set to 0, the API is used to obtain the disposed rule of an application, rather than an application clone.

Return value

Type	Description
DisposedRule	Disposed rule of the application.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.
17700061	AppIndex is not in the valid range.

Example

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

Sets the disposed rule for an application or an application clone.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_DISPOSED_APP_STATUS

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

Parameters

Name	Type	Mandatory	Description
appId	string	Yes	ID of the target application. appId is the unique identifier of an application and is determined by the bundle name and signature information of the application. For details about how to obtain appId, see Obtaining appId of an Application.
rule	DisposedRule	Yes	Disposed rule to set.
appIndex	number	No	Index of the application clone. If this parameter is set to 0, the API is used to set the disposed rule for an application, rather than an application clone.

Error codes

For details about the error codes, see Universal Error Codes and Bundle Error Codes.

ID	Error Message
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
801	Capability not supported.
17700005	The specified app ID is an empty string.
17700061	AppIndex is not in the valid range.

Example

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);
}

DisposedRule¹¹⁺

Defines a disposed rule.

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

System API: This is a system API.

Name	Type	Readable	Writable	Description
want	Want	Yes	Yes	Page displayed when the application is disposed of.
componentType	ComponentType	Yes	Yes	Type of application component that functions as the displayed page.
disposedType	DisposedType	Yes	Yes	Type of application disposal.
controlType	ControlType	Yes	Yes	Control type of application disposal.
elementList	Array<ElementName>	Yes	Yes	List of application components to be disposed of or exempted.
priority	number	Yes	Yes	Priority of the disposed rule.

ComponentType¹¹⁺

Enumerates the types of application components that function as the displayed page.

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

System API: This is a system API.

Name	Value	Description
UI_ABILITY	1	UIAbility component.
UI_EXTENSION	2	UIExtensionAbility component.

DisposedType¹¹⁺

Enumerates the types of application disposals.

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

System API: This is a system API.

Name	Value	Description
BLOCK_APPLICATION	1	All abilities of the application are blocked. That is, the entire application is blocked.
BLOCK_ABILITY	2	A specific ability of the application is blocked.
NON_BLOCK	3	The application is not blocked.

ControlType¹¹⁺

Enumerates the control type of application disposal.

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

System API: This is a system API.

Name	Value	Description
ALLOWED_LIST	1	A trustlist is used, which means that the application components in the list are allowed to run.
DISALLOWED_LIST	2	A blocklist is used, which means that the application components in the list are forbidden to run.

UninstallDisposedRule¹⁵⁺

Describes an uninstallation disposed rule.

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

System API: This is a system API.

Name	Type	Readable	Writable	Description
want	Want	Yes	Yes	Page displayed when the application is disposed of. The default value is empty.
UninstallComponentType	UninstallComponentType	Yes	Yes	Type of the ability to start during interception. The default value is UninstallComponentType.EXTENSION.
priority	number	Yes	Yes	Priority of the disposed rule. The default value is 0. A smaller value indicates a higher priority.

UninstallComponentType¹⁵⁺

Enumerates the types of abilities during uninstallation.

System capability: SystemCapability.BundleManager.BundleFramework.AppControl

System API: This is a system API.

Name	Value	Description
EXTENSION	1	Extension ability.