openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2025-04-17 12:41:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
interface_sdk-js/api/@ohos.enterprise.applicationManager.d.ts
王明曦 45f96c201e manage keep alive apps 
Signed-off-by: 王明曦 <wangmingxi1@h-partners.com>
2024-11-26 20:28:04 +08:00

430 lines
27 KiB
TypeScript
Raw Blame History

/*
* Copyright (c) 2023-2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit MDMKit
*/
import type { AsyncCallback } from './@ohos.base';
import type Want from './@ohos.app.ability.Want';
/**
* This module provides the capability to manage the applications of the enterprise devices.
*
* @namespace applicationManager
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @since 10
*/
declare namespace applicationManager {
/**
* Add appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
* cannot be greater than 200.
* @param { AsyncCallback<void> } callback - the callback of addDisallowedRunningBundles.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @StageModelOnly
* @since 10
*/
function addDisallowedRunningBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Add appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
* cannot be greater than 200.
* @param { number } userId - userId indicates the user ID.
* @param { AsyncCallback<void> } callback - the callback of addDisallowedRunningBundles.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @StageModelOnly
* @since 10
*/
function addDisallowedRunningBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void;
/**
* Add appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
* cannot be greater than 200.
* @param { number } userId - userId indicates the user ID.
* @returns { Promise<void> } the promise returned by the addDisallowedRunningBundles.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @StageModelOnly
* @since 10
*/
function addDisallowedRunningBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>;
/**
* Add appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_APPLICATION
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
* cannot be greater than 200.
* @param { number } [accountId] - accountId indicates the account ID.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @StageModelOnly
* @since 12
*/
function addDisallowedRunningBundlesSync(admin: Want, appIds: Array<string>, accountId?: number): void;
/**
* Remove appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
* cannot be greater than 200.
* @param { AsyncCallback<void> } callback - the callback of removeDisallowedRunningBundles.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @StageModelOnly
* @since 10
*/
function removeDisallowedRunningBundles(admin: Want, appIds: Array<string>, callback: AsyncCallback<void>): void;
/**
* Remove appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
* cannot be greater than 200.
* @param { number } userId - userId indicates the user ID.
* @param { AsyncCallback<void> } callback - the callback of removeDisallowedRunningBundles.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @StageModelOnly
* @since 10
*/
function removeDisallowedRunningBundles(admin: Want, appIds: Array<string>, userId: number, callback: AsyncCallback<void>): void;
/**
* Remove appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
* cannot be greater than 200.
* @param { number } userId - userId indicates the user ID.
* @returns { Promise<void> } the promise returned by the removeDisallowedRunningBundles.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @StageModelOnly
* @since 10
*/
function removeDisallowedRunningBundles(admin: Want, appIds: Array<string>, userId?: number): Promise<void>;
/**
* Remove appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_APPLICATION
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } appIds - ids of the bundle are disallowed to run. The size of the array after setting
* cannot be greater than 200.
* @param { number } [accountId] - accountId indicates the user ID.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @StageModelOnly
* @since 12
*/
function removeDisallowedRunningBundlesSync(admin: Want, appIds: Array<string>, accountId?: number): void;
/**
* Get appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { AsyncCallback<Array<string>> } callback - the callback of getDisallowedRunningBundles.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @StageModelOnly
* @since 10
*/
function getDisallowedRunningBundles(admin: Want, callback: AsyncCallback<Array<string>>): void;
/**
* Get appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { number } userId - userId indicates the user ID.
* @param { AsyncCallback<Array<string>> } callback - the callback of getDisallowedRunningBundles.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @StageModelOnly
* @since 10
*/
function getDisallowedRunningBundles(admin: Want, userId: number, callback: AsyncCallback<Array<string>>): void;
/**
* Get appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SET_APP_RUNNING_POLICY
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { number } userId - userId indicates the user ID.
* @returns { Promise<Array<string>> } the promise returned by the getDisallowedRunningBundles.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @StageModelOnly
* @since 10
*/
function getDisallowedRunningBundles(admin: Want, userId?: number): Promise<Array<string>>;
/**
* Get appid list of bundles that is disallowed to run in the device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_APPLICATION
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { number } [accountId] - accountId indicates the user ID.
* @returns { Array<string> } ids of the bundle are disallowed to run.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @StageModelOnly
* @since 12
*/
function getDisallowedRunningBundlesSync(admin: Want, accountId?: number): Array<string>;
/**
* Adds auto start applications.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_APPLICATION
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<Want> } autoStartApps - autoStartApps indicates the information of auto start app ability.
* The bundleName and abilityName of the want cannot be non-exist.
* The size of the array after setting cannot be greater than 10.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @stagemodelonly
* @since 12
*/
function addAutoStartApps(admin: Want, autoStartApps: Array<Want>): void;
/**
* Removes auto start applications.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_APPLICATION
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<Want> } autoStartApps - autoStartApps indicates the information of auto start app ability.
* The bundleName and abilityName of the want cannot be non-exist.
* The size of the array after setting cannot be greater 10.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @stagemodelonly
* @since 12
*/
function removeAutoStartApps(admin: Want, autoStartApps: Array<Want>): void;
/**
* Gets information of auto start applications.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_APPLICATION
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @returns { Array<Want> } the information of auto start applications.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @stagemodelonly
* @since 12
*/
function getAutoStartApps(admin: Want): Array<Want>;
/**
* Adds the keep alive applications.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_APPLICATION
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } bundleNames - bundleNames indicates the bundle names of applications added to the keep
* alive list.
* @param { number } accountId - accountId indicates the local ID of the OS account.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 9200010 - A conflict policy has been configured.
* @throws { BusinessError } 9201005 - Add keep alive applications failed.
* @throws { BusinessError } 201 - Permission verification failed.The application does not have the permission
* required to call the API
* @throws { BusinessError } 401 - Parameter error.Possible causes: 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;3.Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @stagemodelonly
* @since 14
*/
function addKeepAliveApps(admin: Want, bundleNames: Array<string>, accountId: number): void;
/**
* Removes the keep alive applications.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_APPLICATION
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { Array<string> } bundleNames - bundleNames indicates the bundle names of applications removed from the keep
* alive list.
* @param { number } accountId - accountId indicates the local ID of the OS account.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed.The application does not have the permission
* required to call the API
* @throws { BusinessError } 401 - Parameter error.Possible causes: 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;3.Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @stagemodelonly
* @since 14
*/
function removeKeepAliveApps(admin: Want, bundleNames: Array<string>, accountId: number): void;
/**
* Gets the keep alive applications.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_APPLICATION
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
* The admin must have the corresponding permission.
* @param { number } accountId - accountId indicates the local ID of the OS account.
* @returns { Array<string> } the bundle names of keep alive applications.
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - Permission verification failed.The application does not have the permission
* required to call the API
* @throws { BusinessError } 401 - Parameter error.Possible causes: 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;3.Parameter verification failed.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @stagemodelonly
* @since 14
*/
function getKeepAliveApps(admin: Want, accountId: number): Array<string>;
}
export default applicationManager;
Reference in New Issue View Git Blame Copy Permalink