1# EnterpriseAdminExtensionAbility
2
3## EnterpriseAdminExtensionAbility简介
4
5企业设备管理扩展能力，是MDM（Mobile Device Management）应用必备组件。当开发者为企业开发MDM应用时，需继承EnterpriseAdminExtensionAbility，在EnterpriseAdminExtensionAbility实例中实现MDM业务逻辑，EnterpriseAdminExtensionAbility实现了系统管理状态变化通知功能，并定义了管理应用激活、去激活、应用安装、卸载事件等回调接口。
6
7## 约束与限制
8
9  仅支持设备管理员应用使用。
10
11## 场景：监听设备管理器激活、去激活、应用安装、卸载事件
12
13### 概述
14
15onAdminEnabled：由企业管理员或者员工部署MDM应用，激活设备管理器，系统通知MDM应用已激活DeviceAdmin权限。MDM应用可在onAdminEnabled回调函数中进行初始化策略设置。
16
17onAdminDisabled：由系统或者员工去激活设备管理器，通知去激活DeviceAdmin权限，应用可以通知企业管理员设备已脱管。
18
19onBundleAdded:  企业应用管理场景下，企业管理员订阅应用安装事件，端侧应用安装和卸载事件通知MDM应用，MDM应用可以在回调函数中进行事件上报，通知企业管理员。
20
21onBundleRemoved: 企业应用管理场景下，企业管理员订阅应用卸载事件，端侧应用安装和卸载事件通知MDM应用，MDM应用可以在回调函数中进行事件上报，通知企业管理员。
22
23### 接口说明
24
25| 类名                            | 接口名称                                  | 描述                         |
26| :------------------------------ | ----------------------------------------- | ---------------------------- |
27| EnterpriseAdminExtensionAbility | onAdminEnabled(): void                    | 设备管理器应用激活回调方法   |
28| EnterpriseAdminExtensionAbility | onAdminDisabled(): void                   | 设备管理器应用去激活回调方法 |
29| EnterpriseAdminExtensionAbility | onBundleAdded(bundleName: string): void   | 应用安装回调方法             |
30| EnterpriseAdminExtensionAbility | onBundleRemoved(bundleName: string): void | 应用卸载回调方法             |
31
32### 开发步骤
33
341. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为EnterpriseExtAbility。
352. 在EnterpriseExtAbility目录，右键选择“New > ArkTS File”，新建一个文件并命名为EnterpriseExtAbility.ets。
363. 打开EnterpriseExtAbility.ets文件，导入EnterpriseAdminExtensionAbility模块，自定义类继承EnterpriseAdminExtensionAbility并加上需要的应用通知回调方法，如onAdminEnabled()、onAdminDisabled()等回调方法。当设备管理员应用被激活或者去激活时，则可以在对应回调方法中接受系统发送通知。
37
38```ts
39import EnterpriseAdminExtensionAbility from '@ohos.enterprise.EnterpriseAdminExtensionAbility';
40
41export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility {
42  onAdminEnabled() {
43    console.info("onAdminEnabled");
44  }
45
46  onAdminDisabled() {
47    console.info("onAdminDisabled");
48  }
49
50  onBundleAdded(bundleName: string) {
51    console.info("EnterpriseAdminAbility onBundleAdded bundleName:" + bundleName);
52  }
53
54  onBundleRemoved(bundleName: string) {
55    console.info("EnterpriseAdminAbility onBundleRemoved bundleName" + bundleName);
56  }
57};
58```
59
60​	4.在工程Module对应的[module.json5](../quick-start/module-configuration-file.md)配置文件中注册ServiceExtensionAbility，type标签需要设置为“enterpriseAdmin”，srcEntry标签表示当前ExtensionAbility组件所对应的代码路径。
61
62```json
63"extensionAbilities": [
64      {
65        "name": "ohos.samples.enterprise_admin_ext_ability",
66        "type": "enterpriseAdmin",
67        "exported": true,
68        "srcEntry": "./ets/enterpriseextability/EnterpriseAdminAbility.ets"
69      }
70    ]
71```
72
73## 使用示例
74
75通过@ohos.enterprise.adminManager模块中的subscribeManagedEvent接口进行企业设备管理事件的订阅，订阅应用安装、卸载事件。当订阅成功后，端侧应用安装和卸载事件通知MDM应用，MDM应用可以在回调函数中进行事件上报，通知企业管理员。并可以通过unsubscribeManagedEvent接口进行企业设备管理事件的去订阅。
76
77```ts
78import adminManager from '@ohos.enterprise.adminManager';
79import Want from '@ohos.app.ability.Want';
80import { BusinessError } from '@ohos.base';
81
82async function subscribeManagedEventCallback() {
83  let admin: Want = {
84    bundleName: 'com.example.myapplication',
85    abilityName: 'EntryAbility',
86  }
87  adminManager.subscribeManagedEvent(admin,
88    [adminManager.ManagedEvent.MANAGED_EVENT_BUNDLE_ADDED,
89    adminManager.ManagedEvent.MANAGED_EVENT_BUNDLE_REMOVED], (error) => {
90      if (error) {
91        console.error(`Failed to subscribe managed event. Code: ${error.code}, message: ${error.message}`);
92      } else {
93        console.log('Succeeded in subscribing managed event');
94      }
95    })
96}
97
98async function unsubscribeManagedEventPromise() {
99  let admin: Want = {
100    bundleName: 'com.example.myapplication',
101    abilityName: 'EntryAbility',
102  }
103  await adminManager.unsubscribeManagedEvent(admin,
104    [adminManager.ManagedEvent.MANAGED_EVENT_BUNDLE_ADDED,
105    adminManager.ManagedEvent.MANAGED_EVENT_BUNDLE_REMOVED]).then(() => {
106    console.log('Succeeded in subscribing managed event');
107  }).catch((error: BusinessError) => {
108    console.error(`Failed to subscribe managed event. Code: ${error.code}, message: ${error.message}`);
109  })
110}
111```
112
113## 相关实例
114
115针对EnterpriseAdminExtensionAbility开发，有以下相关示例可供参考：
116
117- [企业设备管理扩展（ArkTS）（Full SDK）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/SystemFeature/ApplicationModels/EnterpriseAdminExtensionAbility)
118