@ohos.enterprise.bundleManager (Bundle Management)
The bundleManager module provides APIs for bundle management, including adding, obtaining, and removing a list of bundles that are allowed to install.
NOTE
The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
The APIs of this module can be used only in the stage model.
The APIs provided by this module can be called only by a device administrator application that is enabled.
Modules to Import
import bundleManager from '@ohos.enterprise.bundleManager';
bundleManager.addAllowedInstallBundles
addAllowedInstallBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void;
Adds the applications that can be installed by the current user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to add. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.addAllowedInstallBundles(wantTemp, appIds, (err) => {
if (err) {
console.error(`Failed to add allowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in adding allowed install bundles');
});
bundleManager.addAllowedInstallBundles
addAllowedInstallBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void;
Adds the applications that can be installed by the specified user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to add. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.addAllowedInstallBundles(wantTemp, appIds, 100, (err) => {
if (err) {
console.error(`Failed to add allowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in adding allowed install bundles');
});
bundleManager.addAllowedInstallBundles
addAllowedInstallBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>;
Adds the applications that can be installed by the current or specified user through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to add. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the applications can be installed by the specified user. - If userId is not passed in, the applications can be installed by the current user. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. If the operation fails, an error object will be thrown. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
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'];
bundleManager.addAllowedInstallBundles(wantTemp, appIds, 100).then(() => {
console.info('Succeeded in adding allowed install bundles');
}).catch((err: BusinessError) => {
console.error(`Failed to add allowed install bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.removeAllowedInstallBundles
removeAllowedInstallBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void;
Removes the applications that can be installed by the current user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to remove. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.removeAllowedInstallBundles(wantTemp, appIds, (err) => {
if (err) {
console.error(`Failed to remove allowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in removing allowed install bundles');
});
bundleManager.removeAllowedInstallBundles
removeAllowedInstallBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void;
Removes the applications that can be installed by the specified user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to remove. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.removeAllowedInstallBundles(wantTemp, appIds, 100, (err) => {
if (err) {
console.error(`Failed to remove allowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in removing allowed install bundles');
});
bundleManager.removeAllowedInstallBundles
removeAllowedInstallBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>;
Removes the applications that can be installed by the current or specified user through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to remove. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the applications can be installed by the specified user. - If userId is not passed in, the applications can be installed by the current user. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. If the operation fails, an error object will be thrown. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
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'];
bundleManager.removeAllowedInstallBundles(wantTemp, appIds, 100).then(() => {
console.info('Succeeded in removing allowed install bundles');
}).catch((err: BusinessError) => {
console.error(`Failed to remove allowed install bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.getAllowedInstallBundles
getAllowedInstallBundles(admin: Want, callback: AsyncCallback<Array<string>>): void;
Obtains the applications that can be installed by the current user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| callback | AsyncCallback<Array<string>> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.getAllowedInstallBundles(wantTemp, (err, result) => {
if (err) {
console.error(`Failed to get allowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info(`Succeeded in getting allowed install bundles, result : ${JSON.stringify(result)}`);
});
bundleManager.getAllowedInstallBundles
getAllowedInstallBundles(admin: Want, userId: number, callback: AsyncCallback<Array<string>>): void;
Obtains the applications that can be installed by the specified user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<Array<string>> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.getAllowedInstallBundles(wantTemp, 100, (err, result) => {
if (err) {
console.error(`Failed to get allowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info(`Succeeded in getting allowed install bundles, result : ${JSON.stringify(result)}`);
});
bundleManager.getAllowedInstallBundles
getAllowedInstallBundles(admin: Want, userId?: number): Promise<Array<string>>;
Obtains the applications that can be installed by the current or specified user through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the applications can be installed by the specified user. - If userId is not passed in, the applications can be installed by the current user. |
Return value
| Type | Description |
|---|---|
| Promise<Array<string>> | Promise used to return the list of the bundles obtained. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.getAllowedInstallBundles(wantTemp, 100).then((result) => {
console.info(`Succeeded in getting allowed install bundles, result : ${JSON.stringify(result)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to get allowed install bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.addDisallowedInstallBundles
addDisallowedInstallBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void;
Adds the applications that cannot be installed by the current user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to add. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.addDisallowedInstallBundles(wantTemp, appIds, (err) => {
if (err) {
console.error(`Failed to add disallowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in adding disallowed install bundles');
});
bundleManager.addDisallowedInstallBundles
addDisallowedInstallBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void;
Adds the applications that cannot be installed by the specified user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to add. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.addDisallowedInstallBundles(wantTemp, appIds, 100, (err) => {
if (err) {
console.error(`Failed to add disallowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in adding disallowed install bundles');
});
bundleManager.addDisallowedInstallBundles
addDisallowedInstallBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>;
Adds the applications that cannot be installed by the current or specified user through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to add. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the applications cannot be installed by the specified user. - If userId is not passed in, the applications cannot be installed by the current user. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. If the operation fails, an error object will be thrown. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
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'];
bundleManager.addDisallowedInstallBundles(wantTemp, appIds, 100).then(() => {
console.info('Succeeded in adding disallowed install bundles');
}).catch((err: BusinessError) => {
console.error(`Failed to add disallowed install bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.removeDisallowedInstallBundles
removeDisallowedInstallBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void;
Removes the applications that cannot be installed by the current user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to remove. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.removeDisallowedInstallBundles(wantTemp, appIds, (err) => {
if (err) {
console.error(`Failed to remove disallowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in removing disallowed install bundles');
});
bundleManager.removeDisallowedInstallBundles
removeDisallowedInstallBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void;
Removes the applications that cannot be installed by the specified user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to remove. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.removeDisallowedInstallBundles(wantTemp, appIds, 100, (err) => {
if (err) {
console.error(`Failed to remove disallowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in removing disallowed install bundles');
});
bundleManager.removeDisallowedInstallBundles
removeDisallowedInstallBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>;
Removes the applications that cannot be installed by the current or specified user through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to remove. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the applications cannot be installed by the specified user. - If userId is not passed in, the applications cannot be installed by the current user. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. If the operation fails, an error object will be thrown. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
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'];
bundleManager.removeDisallowedInstallBundles(wantTemp, appIds, 100).then(() => {
console.info('Succeeded in removing disallowed install bundles');
}).catch((err: BusinessError) => {
console.error(`Failed to remove disallowed install bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.getDisallowedInstallBundles
getDisallowedInstallBundles(admin: Want, callback: AsyncCallback<Array<string>>): void;
Obtains the applications that cannot be installed by the current user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| callback | AsyncCallback<Array<string>> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.getDisallowedInstallBundles(wantTemp, (err, result) => {
if (err) {
console.error(`Failed to get disallowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info(`Succeeded in getting disallowed install bundles, result : ${JSON.stringify(result)}`);
});
bundleManager.getDisallowedInstallBundles
getDisallowedInstallBundles(admin: Want, userId: number, callback: AsyncCallback<Array<string>>): void;
Obtains the applications that cannot be installed by the specified user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<Array<string>> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.getDisallowedInstallBundles(wantTemp, 100, (err, result) => {
if (err) {
console.error(`Failed to get disallowed install bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info(`Succeeded in getting disallowed install bundles, result : ${JSON.stringify(result)}`);
});
bundleManager.getDisallowedInstallBundles
getDisallowedInstallBundles(admin: Want, userId?: number): Promise<Array<string>>;
Obtains the applications that cannot be installed by the current or specified user through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the applications cannot be installed by the specified user. - If userId is not passed in, the applications cannot be installed by the current user. |
Return value
| Type | Description |
|---|---|
| Promise<Array<string>> | Promise used to return the list of the bundles obtained. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.getDisallowedInstallBundles(wantTemp, 100).then((result) => {
console.info(`Succeeded in getting disallowed install bundles, result : ${JSON.stringify(result)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to get disallowed install bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.addDisallowedUninstallBundles
addDisallowedUninstallBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void
Adds the applications that cannot be uninstalled by the current user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to add. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.addDisallowedUninstallBundles(wantTemp, appIds, (err) => {
if (err) {
console.error(`Failed to add disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in adding disallowed uninstall bundles');
});
bundleManager.addDisallowedUninstallBundles
addDisallowedUninstallBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void
Adds the applications that cannot be uninstalled by the specified user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to add. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.addDisallowedUninstallBundles(wantTemp, appIds, 100, (err) => {
if (err) {
console.error(`Failed to add disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in adding disallowed uninstall bundles');
});
bundleManager.addDisallowedUninstallBundles
addDisallowedUninstallBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>
Adds the applications that cannot be uninstalled by the current or specified user through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to add. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the applications cannot be uninstalled by the specified user. - If userId is not passed in, the applications cannot be uninstalled by the current user. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. If the operation fails, an error object will be thrown. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
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'];
bundleManager.addDisallowedUninstallBundles(wantTemp, appIds, 100).then(() => {
console.info('Succeeded in adding disallowed uninstall bundles');
}).catch((err: BusinessError) => {
console.error(`Failed to add disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.removeDisallowedUninstallBundles
removeDisallowedUninstallBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void
Removes the applications that cannot be uninstalled by the current user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to remove. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.removeDisallowedUninstallBundles(wantTemp, appIds, (err) => {
if (err) {
console.error(`Failed to remove disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in removing disallowed uninstall bundles');
});
bundleManager.removeDisallowedUninstallBundles
removeDisallowedUninstallBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void
Removes the applications that cannot be uninstalled by the specified user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to remove. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let appIds: Array<string> = ['com.example.myapplication'];
bundleManager.removeDisallowedUninstallBundles(wantTemp, appIds, 100, (err) => {
if (err) {
console.error(`Failed to remove disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info('Succeeded in removing disallowed uninstall bundles');
});
bundleManager.removeDisallowedUninstallBundles
removeDisallowedUninstallBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>
Removes the applications that cannot be uninstalled by the current or specified user through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| appIds | Array<string> | Yes | IDs of the applications to remove. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the applications cannot be uninstalled by the specified user. - If userId is not passed in, the applications cannot be uninstalled by the current user. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. If the operation fails, an error object will be thrown. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
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'];
bundleManager.removeDisallowedUninstallBundles(wantTemp, appIds, 100).then(() => {
console.info('Succeeded in removing disallowed uninstall bundles');
}).catch((err: BusinessError) => {
console.error(`Failed to remove disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.getDisallowedUninstallBundles
getDisallowedUninstallBundles(admin: Want, callback: AsyncCallback<Array<string>>): void
Obtains the applications that cannot be uninstalled by the current user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| callback | AsyncCallback<Array<string>> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.getDisallowedUninstallBundles(wantTemp, (err, result) => {
if (err) {
console.error(`Failed to get disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info(`Succeeded in getting disallowed uninstall bundles, result : ${JSON.stringify(result)}`);
});
bundleManager.getDisallowedUninstallBundles
getDisallowedUninstallBundles(admin: Want, userId: number, callback: AsyncCallback<Array<string>>): void
Obtains the applications that cannot be uninstalled by the specified user through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<Array<string>> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.getDisallowedUninstallBundles(wantTemp, 100, (err, result) => {
if (err) {
console.error(`Failed to get disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info(`Succeeded in getting disallowed uninstall bundles, result : ${JSON.stringify(result)}`);
});
bundleManager.getDisallowedUninstallBundles
getDisallowedUninstallBundles(admin: Want, userId?: number): Promise<Array<string>>
Obtains the applications that cannot be uninstalled by the current or specified user through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_SET_BUNDLE_INSTALL_POLICY
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the applications cannot be uninstalled by the specified user. - If userId is not passed in, the applications cannot be uninstalled by the current user. |
Return value
| Type | Description |
|---|---|
| Promise<Array<string>> | Promise used to return the bundle list obtained. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.getDisallowedUninstallBundles(wantTemp, 100).then((result) => {
console.info(`Succeeded in getting disallowed uninstall bundles, result : ${JSON.stringify(result)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to get disallowed uninstall bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.uninstall
uninstall(admin: Want, bundleName: string, callback: AsyncCallback<void>): void
Uninstalls an application of the current user without retaining the bundle data through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_INSTALL_BUNDLE
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| bundleName | string | Yes | Name of the bundle to uninstall. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.uninstall(wantTemp, 'bundleName', (err) => {
if (err) {
console.error(`Failed to uninstall bundles. Code is ${err.code}, message is ${err.message}`);
}
console.info('Succeeded in uninstalling bundles');
});
bundleManager.uninstall
uninstall(admin: Want, bundleName: string, userId: number, callback: AsyncCallback<void>): void
Uninstalls an application of the specified user without retaining the bundle data through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_INSTALL_BUNDLE
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| bundleName | string | Yes | Name of the bundle to uninstall. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.uninstall(wantTemp, 'bundleName', 100, (err) => {
if (err) {
console.error(`Failed to uninstall bundles. Code is ${err.code}, message is ${err.message}`);
}
console.info('Succeeded in uninstalling bundles');
});
bundleManager.uninstall
uninstall(admin: Want, bundleName: string, isKeepData: boolean, callback: AsyncCallback<void>): void
Uninstalls an application of the current user through the specified device administrator application. The isKeepData parameter specifies whether to retain the bundle data. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_INSTALL_BUNDLE
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| bundleName | string | Yes | Name of the bundle to uninstall. |
| isKeepData | boolean | Yes | Whether to retain the bundle data. The value true means to retain the bundle data; the value false means the opposite. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.uninstall(wantTemp, 'bundleName', true, (err) => {
if (err) {
console.error(`Failed to uninstall bundles. Code is ${err.code}, message is ${err.message}`);
}
console.info('Succeeded in uninstalling bundles');
});
bundleManager.uninstall
uninstall(admin: Want, bundleName: string, userId: number, isKeepData: boolean, callback: AsyncCallback<void>): void
Uninstalls an application of the specified user through the specified device administrator application. The isKeepData parameter specifies whether to retain the bundle data. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_INSTALL_BUNDLE
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| bundleName | string | Yes | Name of the bundle to uninstall. |
| userId | number | Yes | User ID, which must be greater than or equal to 0. |
| isKeepData | boolean | Yes | Whether to retain the bundle data. The value true means to retain the bundle data; the value false means the opposite. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.uninstall(wantTemp, 'bundleName', 100, true, (err) => {
if (err) {
console.error(`Failed to uninstall bundles. Code is ${err.code}, message is ${err.message}`);
}
console.info('Succeeded in uninstalling bundles');
});
bundleManager.uninstall
uninstall(admin: Want, bundleName: string, userId?: number, isKeepData?: boolean): Promise<void>
Uninstalls an application of the current or specified user through the specified device administrator application. The isKeepData parameter specifies whether to retain the bundle data. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_INSTALL_BUNDLE
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| bundleName | string | Yes | Name of the bundle to uninstall. |
| userId | number | No | User ID, which must be greater than or equal to 0. - If userId is passed in, the application of the specified user is uninstalled. - If userId is not passed in, the application of the current user is uninstalled. |
| isKeepData | boolean | No | Whether to retain the bundle data. The value true means to retain the bundle data; the value false means the opposite. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. An error object will be thrown if the bundle fails to be uninstalled. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
Example
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
bundleManager.uninstall(wantTemp, 'bundleName', 100, true).then(() => {
console.info('Succeeded in uninstalling bundles');
}).catch((err: BusinessError) => {
console.error(`Failed to uninstall bundles. Code is ${err.code}, message is ${err.message}`);
});
bundleManager.install
install(admin: Want, hapFilePaths: Array<string>, callback: AsyncCallback<void>): void
Installs applications through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_INSTALL_BUNDLE
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| hapFilePaths | Array<string> | Yes | Applications to install. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
| 9201002 | the application install failed. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let hapFilePaths: Array<string> = ['/data/storage/el2/base/haps/entry/testinstall/ExtensionTest.hap']
bundleManager.install(wantTemp, hapFilePaths, (err) => {
if (err) {
console.error(`Failed to install bundles. Code is ${err.code}, message is ${err.message}`);
}
console.info('Succeeded in installing bundles');
});
bundleManager.install
install(admin: Want, hapFilePaths: Array<string>, installParam: InstallParam, callback: AsyncCallback<void>): void
Installs applications with specified parameters through the specified device administrator application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.ENTERPRISE_INSTALL_BUNDLE
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| hapFilePaths | Array<string> | Yes | Applications to install. |
| installParam | InstallParam | Yes | Application installation parameters. |
| callback | AsyncCallback<void> | Yes | Callback invoked 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 Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
| 9201002 | the application install failed. |
Example
import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let hapFilePaths: Array<string> = ['/data/storage/el2/base/haps/entry/testinstall/ExtensionTest.hap']
let installParam: bundleManager.InstallParam = {
userId: 100,
installFlag: 1,
};
bundleManager.install(wantTemp, hapFilePaths, installParam, (err) => {
if (err) {
console.error(`Failed to install bundles. Code is ${err.code}, message is ${err.message}`);
}
console.info('Succeeded in installing bundles');
});
bundleManager.install
install(admin: Want, hapFilePaths: Array<string>, installParam?: InstallParam): Promise<void>
Installs applications through the specified device administrator application. This API uses a promise to return the result.
Required permissions: ohos.permission.ENTERPRISE_INSTALL_BUNDLE
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| admin | Want | Yes | Device administrator application. |
| hapFilePaths | Array<string> | Yes | Applications to install. |
| installParam | InstallParam | No | Application installation parameters. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. If the operation fails, an error object will be thrown. |
Error codes
For details about the error codes, see Enterprise Device Management Error Codes.
| ID | Error Message |
|---|---|
| 9200001 | the application is not an administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
| 9201002 | the application install failed. |
Example
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
};
let hapFilePaths: Array<string> = ['/data/storage/el2/base/haps/entry/testinstall/ExtensionTest.hap']
bundleManager.install(wantTemp, hapFilePaths).then(() => {
console.info('Succeeded in installing bundles');
}).catch((err: BusinessError) => {
console.error(`Failed to install bundles. Code is ${err.code}, message is ${err.message}`);
});
InstallParam
Defines the parameters specified for installing applications.
System capability: SystemCapability.Customization.EnterpriseDeviceManager
System API: This is a system API.
| Name | Type | Mandatory | Description |
|---|---|---|---|
| userId | number | No | User ID, which must be greater than or equal to 0. The default value is the user ID of the caller. |
| installFlag | number | No | Installation flag. - 0: initial installation. - 1: overwrite installation. - 2: installation-free. Default value: 0 |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙System Common Events (To Be Deprecated Soon)
harmony 鸿蒙System Common Events
harmony 鸿蒙API Reference Document Description
harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)
harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)
harmony 鸿蒙@ohos.bundle (Bundle)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)