提交 192ffada 编写于 作者: C caiminggang

添加EnterpriseAdminExtentionAbility模块描述

Signed-off-by: Ncaiminggang <caiminggang1@huawei.com>
上级 5c8c3c08
# EnterpriseAdminExtentionAbility
EnterpriseAdminExtentionAbility模块提供企业管理员应用扩展相关接口。
本模块提供企业管理员应用拓展能力。
企业管理员应用需要存在一个EnterpriseAdminExtentionAbility并重写相关接口,以此具备模块提供的各项能力,比如接收由系统发送的该应用被激活或者去激活的通知。
> **说明:**
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```ts
......@@ -22,12 +26,12 @@ onAdminEnabled(): void
**示例:**
```ts
```ts
export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility {
onAdminEnabled() {
}
};
```
```
## EnterpriseAdminExtentionAbility.onAdminDisabled
......@@ -39,10 +43,9 @@ onAdminDisabled(): void
**示例:**
```ts
```ts
export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility {
onAdminDisabled() {
}
};
```
\ No newline at end of file
```
# 企业设备管理
本模块提供企业设备管理能力,使设备具备企业场景下所需的定制能力。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import enterpriseDeviceManager from '@ohos.enterpriseDeviceManager';
```
## enterpriseDeviceManager.enableAdmin
enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId?: number, callback: AsyncCallback\<boolean>): void
......@@ -27,7 +27,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | ---- | ----------------------------------------------------- |
| -------------- | ----------------------------------- | --- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 |
......@@ -69,7 +69,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | ---- | ----------------------------------------------------- |
| -------------- | ----------------------------------- | --- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 |
......@@ -115,7 +115,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ----------------------------------------------------- |
| -------- | ----------------------------------- | --- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 |
| userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 |
......@@ -136,8 +136,6 @@ enterpriseDeviceManager.disableAdmin(wantTemp, 100, (error, result) => {
});
```
## enterpriseDeviceManager.disableAdmin
disableAdmin(admin: Want, userId?: number): Promise\<boolean>
......@@ -153,7 +151,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | ---- | ----------------------------------------------------- |
| ------ | ----------------------------------- | --- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 |
| userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
......@@ -189,7 +187,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------- | ---- | ------------------- |
| ---------- | ----------------------- | --- | ------------------- |
| bundleName | String | 是 | 超级设备管理员应用的包名 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 |
......@@ -218,7 +216,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ------------ |
| ---------- | ------ | --- | ------------ |
| bundleName | String | 是 | 超级设备管理员应用的包名 |
**返回值:**
......@@ -250,7 +248,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ----------------------------------------------------- |
| -------- | ----------------------------------- | --- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 |
......@@ -271,8 +269,6 @@ enterpriseDeviceManager.isAdminEnabled(wantTemp, 100, (error, result) => {
});
```
## enterpriseDeviceManager.isAdminEnabled
isAdminEnabled(admin: Want, userId?: number): Promise\<boolean>
......@@ -285,7 +281,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | ---- | ----------------------------------------------------- |
| ------ | ----------------------------------- | --- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
......@@ -321,7 +317,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------- | ---- | -------------------- |
| ---------- | ----------------------- | --- | -------------------- |
| bundleName | String | 是 | 设备管理员应用 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 |
......@@ -338,8 +334,6 @@ enterpriseDeviceManager.isSuperAdmin(bundleName, (error, result) => {
});
```
## enterpriseDeviceManager.isSuperAdmin
isSuperAdmin(bundleName: String): Promise\<boolean>
......@@ -352,7 +346,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | --------- |
| ---------- | ------ | --- | --------- |
| bundleName | String | 是 | 超级设备管理员应用 |
**返回值:**
......@@ -384,7 +378,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ----------------------------------- |
| -------- | --------------------------------------- | --- | ----------------------------------- |
| callback | AsyncCallback<DeviceSettingsManager&gt; | 是 | callback方式返回DeviceSettingsManager对象 |
**示例:**
......@@ -409,7 +403,6 @@ enterpriseDeviceManager.getDeviceSettingsManager((error, mgr) => {
});
```
## enterpriseDeviceManager.getDeviceSettingsManager
getDeviceSettingsManager(): Promise&lt;DeviceSettingsManager&gt;
......@@ -455,7 +448,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | ---- | ---------------------- |
| -------------- | ----------------------------------- | --- | ---------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| callback | AsyncCallback\<boolean&gt; | 是 | callback方式返回是否设置企业信息成功 |
......@@ -479,7 +472,6 @@ enterpriseDeviceManager.setEnterpriseInfo(wantTemp, enterpriseInfo)
});
```
## enterpriseDeviceManager.setEnterpriseInfo
setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise&lt;boolean&gt;
......@@ -492,7 +484,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | ---- | ------------ |
| -------------- | ----------------------------------- | --- | ------------ |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
......@@ -533,7 +525,7 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------ |
| -------- | ------------------------------------------------------ | --- | ------------------------ |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| callback | AsyncCallback&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | 是 | callback方式返回设备管理员应用的企业信息 |
......@@ -554,7 +546,6 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp, (error, result) => {
});
```
## enterpriseDeviceManager.getEnterpriseInfo
getEnterpriseInfo(admin: Want): Promise&lt;EnterpriseInfo&gt;
......@@ -567,13 +558,13 @@ SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----------------------------------- | ---- | ------- |
| ----- | ----------------------------------- | --- | ------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------- |
| ------------------------------------------------ | ------------------------- |
| Promise&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | Promise方式返回设备管理员应用的企业信息对象 |
**示例:**
......@@ -602,7 +593,6 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => {
| name | 只读 | string | 是 | 表示设备管理员应用所属企业的名称。 |
| description | 只读 | string | 是 | 表示设备管理员应用所属企业的描述。 |
## AdminType
设备管理员应用的管理员类型。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册