1# @ohos.enterprise.EnterpriseAdminExtensionAbility（企业设备管理扩展能力） 2 3本模块提供企业设备管理扩展能力。 4 5设备管理应用需要存在一个EnterpriseAdminExtensionAbility并重写相关接口，以此具备模块提供的各项能力，比如接收由系统发送的该应用被激活或者解除激活的通知。 6 7> **说明：** 8> 9> 本模块首批接口从API version 12 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 10> 11> 本模块接口仅可在Stage模型下使用。 12> 13 14## 导入模块 15 16```ts 17import { EnterpriseAdminExtensionAbility } from '@kit.MDMKit' 18``` 19 20## EnterpriseAdminExtensionAbility.onAdminEnabled 21 22onAdminEnabled(): void 23 24设备管理应用被激活事件回调。企业管理员或者员工部署设备管理应用，激活设备管理，系统通知设备管理应用已激活admin权限。设备管理应用可在此回调函数中进行初始化策略设置。 25 26**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 27 28 29 30**示例：** 31 32```ts 33export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 34 onAdminEnabled() { 35 } 36}; 37``` 38 39## EnterpriseAdminExtensionAbility.onAdminDisabled 40 41onAdminDisabled(): void 42 43设备管理应用被解除激活事件回调。企业管理员或者员工解除激活设备管理，系统通知设备管理应用已解除激活admin权限。设备管理应用可在此回调函数中通知企业管理员设备已脱管。 44 45**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 46 47 48 49**示例：** 50 51```ts 52export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 53 onAdminDisabled() { 54 } 55}; 56``` 57 58## EnterpriseAdminExtensionAbility.onBundleAdded 59 60onBundleAdded(bundleName: string): void 61 62应用安装事件回调，回调中包含应用包名。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_BUNDLE_ADDED事件才能收到此回调。企业设备管理场景下，设备管理应用订阅应用安装事件，端侧应用安装事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 63 64**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 65 66 67 68**参数：** 69 70| 参数名 | 类型 | 必填 | 说明 | 71| ----- | ----------------------------------- | ---- | ------- | 72| bundleName | string | 是 | 被安装应用的包名。 | 73 74**示例：** 75 76```ts 77export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 78 onBundleAdded(bundleName: string) { 79 console.info(`Succeeded in calling onBundleAdded callback, added bundle name : ${bundleName}`); 80 } 81}; 82``` 83 84## EnterpriseAdminExtensionAbility.onBundleAdded<sup>14+</sup> 85 86onBundleAdded(bundleName: string, accountId: number): void 87 88应用安装事件回调，回调中包含应用包名和账号ID。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_BUNDLE_ADDED事件才能收到此回调。企业设备管理场景下，设备管理应用订阅应用安装事件，端侧应用安装事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 89 90**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 91 92 93 94**参数：** 95 96| 参数名 | 类型 | 必填 | 说明 | 97| ----- | ----------------------------------- | ---- | ------- | 98| bundleName | string | 是 | 被安装应用的包名。 | 99| accountId | number | 是 | 被安装应用所在的用户ID。 | 100 101**示例：** 102 103```ts 104export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 105 onBundleAdded(bundleName: string, accountId?: number) { 106 console.info(`Succeeded in calling onBundleAdded callback, added bundle name : ${bundleName}, accountId: ${accountId}`); 107 } 108}; 109``` 110 111## EnterpriseAdminExtensionAbility.onBundleRemoved 112 113onBundleRemoved(bundleName: string): void 114 115应用卸载事件回调，回调中包含应用包名。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_BUNDLE_REMOVED事件才能收到此回调。企业设备管理场景下，设备管理应用订阅应用卸载事件，端侧应用卸载事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 116 117**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 118 119 120 121**参数：** 122 123| 参数名 | 类型 | 必填 | 说明 | 124| ----- | ----------------------------------- | ---- | ------- | 125| bundleName | string | 是 | 被卸载应用的包名。 | 126 127**示例：** 128 129```ts 130export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 131 onBundleRemoved(bundleName: string) { 132 console.info(`Succeeded in calling onBundleRemoved callback, removed bundle name : ${bundleName}`); 133 } 134}; 135``` 136 137## EnterpriseAdminExtensionAbility.onBundleRemoved<sup>14+</sup> 138 139onBundleRemoved(bundleName: string, accountId: number): void 140 141应用卸载事件回调，回调中包含应用包名和账号ID。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_BUNDLE_REMOVED事件才能收到此回调。企业设备管理场景下，设备管理应用订阅应用卸载事件，端侧应用卸载事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 142 143**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 144 145 146 147**参数：** 148 149| 参数名 | 类型 | 必填 | 说明 | 150| ----- | ----------------------------------- | ---- | ------- | 151| bundleName | string | 是 | 被卸载应用的包名。 | 152| accountId | number | 是 | 被卸载应用所在的用户ID。 | 153 154**示例：** 155 156```ts 157export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 158 onBundleRemoved(bundleName: string, accountId?: number) { 159 console.info(`Succeeded in calling onBundleRemoved callback, removed bundle name : ${bundleName}, accountId: ${accountId}`); 160 } 161}; 162``` 163 164## EnterpriseAdminExtensionAbility.onAppStart 165 166onAppStart(bundleName: string): void 167 168应用启动事件回调。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_APP_START事件才能收到此回调。企业设备管理场景下，设备管理应用订阅应用启动事件，端侧应用启动事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 169 170**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 171 172 173 174**参数：** 175 176| 参数名 | 类型 | 必填 | 说明 | 177| ----- | ----------------------------------- | ---- | ------- | 178| bundleName | string | 是 | 启动应用的包名。 | 179 180**示例：** 181 182```ts 183export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 184 onAppStart(bundleName: string) { 185 console.info(`Succeeded in calling onAppStart callback, started bundle name : ${bundleName}`); 186 } 187}; 188``` 189 190## EnterpriseAdminExtensionAbility.onAppStop 191 192onAppStop(bundleName: string): void 193 194应用停止事件回调。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_APP_STOP事件才能收到此回调。企业设备管理场景下，设备管理应用订阅应用停止事件，端侧应用停止事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 195 196**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 197 198 199 200**参数：** 201 202| 参数名 | 类型 | 必填 | 说明 | 203| ----- | ----------------------------------- | ---- | ------- | 204| bundleName | string | 是 | 停止应用的包名。 | 205 206**示例：** 207 208```ts 209export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 210 onAppStop(bundleName: string) { 211 console.info(`Succeeded in calling onAppStop callback, stopped bundle name : ${bundleName}`); 212 } 213}; 214``` 215## EnterpriseAdminExtensionAbility.onSystemUpdate 216 217onSystemUpdate(systemUpdateInfo: systemManager.SystemUpdateInfo): void 218 219系统更新事件回调。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_SYSTEM_UPDATE事件才能收到此回调。企业设备管理场景下，设备管理应用订阅系统更新事件，端侧系统更新事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 220 221**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 222 223 224 225**参数：** 226 227| 参数名 | 类型 | 必填 | 说明 | 228| ---------------- | ------------------------------------------------------------ | ---- | -------------------- | 229| systemUpdateInfo | [systemManager.SystemUpdateInfo](js-apis-enterprise-systemManager.md#systemupdateinfo) | 是 | 系统更新的版本信息。 | 230 231**示例：** 232 233```ts 234import { systemManager } from '@kit.MDMKit'; 235export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 236 onSystemUpdate(systemUpdateInfo: systemManager.SystemUpdateInfo) { 237 console.info(`Succeeded in calling onSystemUpdate callback, version name : ${systemUpdateInfo.versionName}`); 238 } 239}; 240``` 241 242## EnterpriseAdminExtensionAbility.onStart 243 244onStart(): void 245 246EnterpriseAdminExtensionAbility启动事件回调。 247 248**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 249 250 251 252**示例：** 253 254```ts 255export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 256 onStart() { 257 console.info(`Succeeded in calling onStart callback.`); 258 } 259}; 260``` 261 262## EnterpriseAdminExtensionAbility.onAccountAdded<sup>18+</sup> 263 264onAccountAdded(accountId: number): void 265 266系统账号新增事件回调。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_ACCOUNT_ADDED事件才能收到此回调。企业设备管理场景下，设备管理应用订阅系统账号新增事件，端侧系统更新事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 267 268**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 269 270**参数：** 271 272| 参数名 | 类型 | 必填 | 说明 | 273| ----- | ----------------------------------- | ---- | ------- | 274| accountId | number | 是 | 新增的用户ID。 | 275 276**示例：** 277 278```ts 279export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 280 onAccountAdded(accountId: number) { 281 console.info(`Succeeded in calling onAccountAdded callback, added accountId: ${accountId}`); 282 } 283}; 284``` 285 286## EnterpriseAdminExtensionAbility.onAccountSwitched<sup>18+</sup> 287 288onAccountSwitched(accountId: number): void 289 290系统账号切换事件回调。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_ACCOUNT_SWITCHED事件才能收到此回调。企业设备管理场景下，设备管理应用订阅系统账号切换事件，端侧系统更新事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 291 292**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 293 294**参数：** 295 296| 参数名 | 类型 | 必填 | 说明 | 297| ----- | ----------------------------------- | ---- | ------- | 298| accountId | number | 是 | 切换后的用户ID。 | 299 300**示例：** 301 302```ts 303export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 304 onAccountSwitched(accountId: number) { 305 console.info(`Succeeded in calling onAccountSwitched callback, switched accountId: ${accountId}`); 306 } 307}; 308``` 309 310## EnterpriseAdminExtensionAbility.onAccountRemoved<sup>18+</sup> 311 312onAccountRemoved(accountId: number): void 313 314系统账号删除事件回调。通过接口[adminManager.subscribeManagedEventSync](js-apis-enterprise-adminManager.md#adminmanagersubscribemanagedeventsync)注册MANAGED_EVENT_ACCOUNT_REMOVED事件才能收到此回调。企业设备管理场景下，设备管理应用订阅系统账号删除事件，端侧系统更新事件通知设备管理应用，设备管理应用可以在此回调函数中进行事件上报，通知企业管理员。 315 316**系统能力**：SystemCapability.Customization.EnterpriseDeviceManager 317 318**参数：** 319 320| 参数名 | 类型 | 必填 | 说明 | 321| ----- | ----------------------------------- | ---- | ------- | 322| accountId | number | 是 | 被删除的用户ID。 | 323 324**示例：** 325 326```ts 327export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { 328 onAccountRemoved(accountId: number) { 329 console.info(`Succeeded in calling onAccountRemoved callback, removed accountId: ${accountId}`); 330 } 331}; 332```