Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Coping0606
Docs
提交
be7d1cf1
D
Docs
项目概览
Coping0606
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
be7d1cf1
编写于
3月 15, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 15, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2040 enterprise device manager接口新增
Merge pull request !2040 from 蔡明港/master
上级
c04fba19
1f6b410c
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
609 addition
and
0 deletion
+609
-0
zh-cn/application-dev/reference/apis/Readme-CN.md
zh-cn/application-dev/reference/apis/Readme-CN.md
+1
-0
zh-cn/application-dev/reference/apis/js-apis-enterprise-device-manager.md
...n-dev/reference/apis/js-apis-enterprise-device-manager.md
+608
-0
未找到文件。
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @
be7d1cf1
...
...
@@ -121,3 +121,4 @@
-
[
非线性容器LightWeightSet
](
js-apis-lightweightset.md
)
-
定制管理
-
[
配置策略
](
js-apis-config-policy.md
)
-
[
企业设备管理
](
js-apis-enterprise-device-manager.md
)
zh-cn/application-dev/reference/apis/js-apis-enterprise-device-manager.md
0 → 100644
浏览文件 @
be7d1cf1
# 企业设备管理
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
import enterpriseDeviceManager from '@ohos.enterpriseDeviceManager';
```
## enterpriseDeviceManager.activateAdmin
activateAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callback: AsyncCallback
\<
boolean>): void
以异步方法根据给定的包名和类名激活设备管理员应用,使用Callback形式返回是否激活成功。
**需要权限:**
ohos.permission.MANAGE_ADMIN
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 设备管理员应用 |
| enterpriseInfo |
[
EnterpriseInfo
](
#EnterpriseInfo
)
| 是 | 设备管理员应用的企业信息 |
| type |
[
AdminType
](
#AdminType
)
| 是 | 激活的设备管理员类型 |
| callback | AsyncCallback
\<
boolean> | 是 | callback方式返回是否激活成功 |
**示例**
:
```
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
name = "enterprise name",
description = "enterprise description"
}
enterpriseDeviceManager.activateAdmin(wantTemp, enterpriseInfo, enterpriseDeviceManager.AdminType.ADMIN_TYPE_NORMAL, (error, result) => {
if (error != null) {
console.log("error occurs" + error);
return;
}
console.log(result);
});
```
## enterpriseDeviceManager.activateAdmin
activateAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType): Promise
\<
boolean>
以异步方法根据给定的包名和类名激活设备管理员应用,使用Promise形式返回是否激活成功。
**需要权限:**
ohos.permission.MANAGE_ADMIN
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------------- | ---- | ------------------------ |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 设备管理员应用 |
| enterpriseInfo |
[
EnterpriseInfo
](
#EnterpriseInfo
)
| 是 | 设备管理员应用的企业信息 |
| type |
[
AdminType
](
#AdminType
)
| 是 | 激活的设备管理员类型 |
**返回值:**
| 类型 | 说明 |
| ----------------- | --------------------------- |
| Promise
\<
boolean> | Promise形式返回是否激活成功 |
**示例**
:
```
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
name = "enterprise name",
description = "enterprise description"
}
enterpriseDeviceManager.activateAdmin(wantTemp, enterpriseInfo, enterpriseDeviceManager.AdminType.ADMIN_TYPE_NORMAL)
.then((result) => {
console.log(result);
}).catch(error => {
console.log("error occurs" + error);
});
```
## enterpriseDeviceManager.deactivateAdmin
deactivateAdmin(admin: Want, callback: AsyncCallback
\<
boolean>): void
以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Callback形式返回是否去激活成功。
**需要权限:**
ohos.permission.MANAGE_ADMIN
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | ------------------------------ |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 普通设备管理员应用 |
| callback | AsyncCallback
\<
boolean> | 是 | callback方式返回是否去激活成功 |
**示例**
:
```
let wantTemp = {
bundleName: elementName.bundleName,
abilityName: elementName.abilityName,
};
enterpriseDeviceManager.deactivateAdmin(wantTemp, (error, result) => {
if (error != null) {
console.log("error occurs" + error);
return;
}
console.log(result);
});
```
## enterpriseDeviceManager.deactivateAdmin
deactivateAdmin(admin: Want): Promise
\<
boolean>
以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Promise形式返回是否去激活成功。
**需要权限:**
ohos.permission.MANAGE_ADMIN
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------- | ---- | ------------------ |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 普通设备管理员应用 |
**返回值:**
| 类型 | 说明 |
| ----------------- | --------------------------- |
| Promise
\<
boolean> | Promise形式返回是否激活成功 |
**示例**
:
```
let wantTemp = {
bundleName: "bundleName",
abilityName: "abilityName",
};
enterpriseDeviceManager.deactivateAdmin(wantTemp).then((result) => {
console.log(result);
}).catch(error => {
console.log("error occurs" + error);
});
```
## enterpriseDeviceManager.deactivateSuperAdmin
deactivateSuperAdmin(bundleName: String, callback: AsyncCallback
\<
boolean>): void
以异步方法根据给定的包名将设备超级管理员应用去激活,使用Callback形式返回是否去激活成功。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------- | ---- | ------------------------------ |
| bundleName | String | 是 | 超级设备管理员应用的包名 |
| callback | AsyncCallback
\<
boolean> | 是 | callback方式返回是否去激活成功 |
**示例**
:
```
let bundleName = "com.example.myapplication";
enterpriseDeviceManager.deactivateSuperAdmin(bundleName, (error, result) => {
if (error != null) {
console.log("error occurs" + error);
return;
}
console.log(result);
});
```
## enterpriseDeviceManager.deactivateSuperAdmin
deactivateSuperAdmin(bundleName: String): Promise
\<
boolean>
以异步方法根据给定的包名将设备超级管理员应用去激活,使用Promise形式返回是否去激活成功。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ------------------------ |
| bundleName | String | 是 | 超级设备管理员应用的包名 |
**返回值:**
| 类型 | 说明 |
| ----------------- | --------------------------- |
| Promise
\<
boolean> | Promise形式返回是否激活成功 |
**示例**
:
```
let bundleName = "com.example.myapplication";
enterpriseDeviceManager.deactivateSuperAdmin(bundleName).then((result) => {
console.log(result);
}).catch(error => {
console.log("error occurs" + error);
});
```
## enterpriseDeviceManager.isAdminAppActive
isAdminAppActive(admin: Want, callback: AsyncCallback
\<
boolean>): void
以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Callback形式返回是否处于激活状态。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | -------------------------------- |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 设备管理员应用 |
| callback | AsyncCallback
\<
boolean> | 是 | callback方式返回是否处于激活状态 |
**示例**
:
```
let wantTemp = {
bundleName: elementName.bundleName,
abilityName: elementName.abilityName,
};
enterpriseDeviceManager.isAdminAppActive(wantTemp, (error, result) => {
if (error != null) {
console.log("error occurs" + error);
return;
}
console.log(result);
});
```
## enterpriseDeviceManager.isAdminAppActive
isAdminAppActive(admin: Want): Promise
\<
boolean>
以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Promise形式返回是否处于激活状态。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------- | ---- | -------------- |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 设备管理员应用 |
**返回值:**
| 类型 | 说明 |
| ----------------- | ------------------------------- |
| Promise
\<
boolean> | Promise形式返回是否处于激活状态 |
**示例**
:
```
let wantTemp = {
bundleName: "bundleName",
abilityName: "abilityName",
};
enterpriseDeviceManager.isAdminAppActive(wantTemp).then((result) => {
console.log(result);
}).catch(error => {
console.log("error occurs" + error);
});
```
## enterpriseDeviceManager.isSuperAdmin
isSuperAdmin(bundleName: String, callback: AsyncCallback
\<
boolean>): void
以异步方法根据给定的包名判断设备超级管理员应用是否被激活,使用Callback形式返回是否处于激活状态。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------- | ---- | -------------------------------- |
| bundleName | String | 是 | 设备管理员应用 |
| callback | AsyncCallback
\<
boolean> | 是 | callback方式返回是否处于激活状态 |
**示例**
:
```
let bundleName = "com.example.myapplication";
enterpriseDeviceManager.isSuperAdmin(bundleName, (error, result) => {
if (error != null) {
console.log("error occurs" + error);
return;
}
console.log(result);
});
```
## enterpriseDeviceManager.isSuperAdmin
isSuperAdmin(bundleName: String): Promise
\<
boolean>
以异步方法根据给定的包名判断设备超级管理员应用是否被激活,使用Promise形式返回是否处于激活状态。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ------------------ |
| bundleName | String | 是 | 超级设备管理员应用 |
**返回值:**
| 类型 | 说明 |
| ----------------- | ------------------------------- |
| Promise
\<
boolean> | Promise形式返回是否处于激活状态 |
**示例**
:
```
let bundleName = "com.example.myapplication";
enterpriseDeviceManager.isSuperAdmin(bundleName).then((result) => {
console.log(result);
}).catch(error => {
console.log("error occurs" + error);
});
```
## enterpriseDeviceManager.getDeviceSettingsManager
getDeviceSettingsManager(callback: AsyncCallback
<
DeviceSettingsManager
>
): void
获取DeviceSettingsManager对象,使用callback形式返回DeviceSettingsManager对象。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<DeviceSettingsManager
>
| 是 | callback方式返回DeviceSettingsManager对象 |
**示例:**
```
let wantTemp = {
bundleName: "bundleName",
abilityName: "abilityName",
};
enterpriseDeviceManager.getDeviceSettingsManager((error, mgr) => {
if (error != null) {
console.log("error occurs" + error);
return;
}
mgr.setDateTime(wantTemp, 1526003846000, (error, value) => {
if (error != null) {
console.log(error);
} else {
console.log(value);
}
});
});
```
## enterpriseDeviceManager.getDeviceSettingsManager
getDeviceSettingsManager(): Promise
<
DeviceSettingsManager
>
获取DeviceSettingsManager对象,使用Promise形式返回DeviceSettingsManager对象。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
DeviceSettingsManager
>
| Promise方式返回DeviceSettingsManager对象 |
**示例:**
```
let wantTemp = {
bundleName: "bundleName",
abilityName: "abilityName",
};
mgr.getDeviceSettingsManager().then((mgr) => {
mgr.setDateTime(wantTemp, 1526003846000).then((value) => {
console.log(value);
}).catch((error) => {
console.log(error);
})
}).catch((error) => {
console.log(error);
})
```
## enterpriseDeviceManager.setEnterpriseInfo
setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCallback
<
boolean
>
): void
设置设备管理员应用的企业信息,使用callback形式返回是否设置成功。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------------- | ---- | ------------------------------------ |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 设备管理员应用 |
| enterpriseInfo |
[
EnterpriseInfo
](
#EnterpriseInfo
)
| 是 | 设备管理员应用的企业信息 |
| callback | AsyncCallback
\<
boolean
>
| 是 | callback方式返回是否设置企业信息成功 |
**示例:**
```
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
name = "enterprise name",
description = "enterprise description"
}
enterpriseDeviceManager.setEnterpriseInfo(wantTemp, enterpriseInfo)
.then((result) => {
console.log(result);
}).catch(error => {
console.log("error occurs" + error);
});
```
## enterpriseDeviceManager.setEnterpriseInfo
setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise
<
boolean
>
设置设备管理员应用的企业信息,使用callback形式返回是否设置成功。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------------- | ---- | ------------------------ |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 设备管理员应用 |
| enterpriseInfo |
[
EnterpriseInfo
](
#EnterpriseInfo
)
| 是 | 设备管理员应用的厂商信息 |
**返回值:**
| 类型 | 说明 |
| ------------------ | ----------------------------------- |
| Promise
\<
boolean>; | Promise方式返回是否设置企业信息成功 |
**示例:**
```
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
name = "enterprise name",
description = "enterprise description"
}
enterpriseDeviceManager.setEnterpriseInfo(wantTemp, enterpriseInfo)
.then((result) => {
console.log(result);
}).catch(error => {
console.log("error occurs" + error);
});
```
## enterpriseDeviceManager.getEnterpriseInfo
getEnterpriseInfo(admin: Want, callback: AsyncCallback
<
EnterpriseInfo
>
): void
获取设备管理员应用的企业信息,使用callback形式返回设备管理员应用的企业信息。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------------------------------------- |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 设备管理员应用 |
| callback | AsyncCallback
<
[EnterpriseInfo](#EnterpriseInfo)
>
| 是 | callback方式返回设备管理员应用的企业信息 |
**示例:**
```
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
enterpriseDeviceManager.getEnterpriseInfo(wantTemp, (error, result) => {
if (error != null) {
console.log("error occurs" + error);
return;
}
console.log(result.name);
console.log(result.description);
});
```
## enterpriseDeviceManager.getEnterpriseInfo
getDeviceSettingsManager(admin: Want): Promise
<
EnterpriseInfo
>
获取设备管理员应用的企业信息,使用Promise形式返回设备管理员应用的企业信息。
**系统能力:**
SystemCapability.Customation.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---------------------------------------------- | ---- | -------------- |
| admin |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 设备管理员应用 |
**返回值:**
| 类型 | 说明 |
| ------------------------------------------------ | ------------------------------------------- |
| Promise
<
[EnterpriseInfo](#EnterpriseInfo)
>
| Promise方式返回设备管理员应用的企业信息对象 |
**示例:**
```
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => {
console.log(result.name);
console.log(result.description);
}).catch(error => {
console.log("error occurs" + error);
});
```
## EnterpriseInfo
设备管理员应用的企业信息
**系统能力:**
以下各项对应系统能力均为SystemCapability.Customation.EnterpriseDeviceManager
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ---------------------------------- |
| name | 只读 | string | 是 | 表示设备管理员应用所属企业的名称。 |
| description | 只读 | string | 是 | 表示设备管理员应用所属企业的描述。 |
## AdminType
设备管理员应用的管理员类型。
**系统能力:**
以下各项对应系统能力均为SystemCapability.Customation.EnterpriseDeviceManager
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ADMIN_TYPE_NORMAL | 0x00 | 普通管理员 |
| ADMIN_TYPE_SUPER | 0x01 | 超级管理员 |
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录