提交 9f0665c9 编写于 作者: L liwuli

update EDM API docs

Signed-off-by: Nliwuli <liwuli@huawei.com>
上级 bbc278c1
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
## 导入模块 ## 导入模块
```ts ```ts
import EnterpriseAdminExtensionAbility from '@ohos.EnterpriseAdminExtensionAbility' import EnterpriseAdminExtensionAbility from '@ohos.enterprise.EnterpriseAdminExtensionAbility'
``` ```
## EnterpriseAdminExtensionAbility.onAdminEnabled ## EnterpriseAdminExtensionAbility.onAdminEnabled
......
...@@ -9,10 +9,10 @@ ...@@ -9,10 +9,10 @@
## 导入模块 ## 导入模块
```js ```js
import enterpriseDeviceManager from '@ohos.enterpriseDeviceManager'; import adminManager from '@ohos.enterprise.adminManager';
``` ```
## enterpriseDeviceManager.enableAdmin ## adminManager.enableAdmin
enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callback: AsyncCallback\<void>): void enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callback: AsyncCallback\<void>): void
...@@ -54,7 +54,7 @@ let enterpriseInfo = { ...@@ -54,7 +54,7 @@ let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
description: "enterprise description" description: "enterprise description"
} }
enterpriseDeviceManager.enableAdmin(wantTemp, enterpriseInfo, enterpriseDeviceManager.AdminType.ADMIN_TYPE_NORMAL, error => { adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_TYPE_NORMAL, error => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -63,7 +63,7 @@ enterpriseDeviceManager.enableAdmin(wantTemp, enterpriseInfo, enterpriseDeviceMa ...@@ -63,7 +63,7 @@ enterpriseDeviceManager.enableAdmin(wantTemp, enterpriseInfo, enterpriseDeviceMa
}); });
``` ```
## enterpriseDeviceManager.enableAdmin ## adminManager.enableAdmin
enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId: number, callback: AsyncCallback\<void>): void enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId: number, callback: AsyncCallback\<void>): void
...@@ -106,7 +106,7 @@ let enterpriseInfo = { ...@@ -106,7 +106,7 @@ let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
description: "enterprise description" description: "enterprise description"
} }
enterpriseDeviceManager.enableAdmin(wantTemp, enterpriseInfo, enterpriseDeviceManager.AdminType.ADMIN_TYPE_NORMAL, 100, error => { adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_TYPE_NORMAL, 100, error => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -115,7 +115,7 @@ enterpriseDeviceManager.enableAdmin(wantTemp, enterpriseInfo, enterpriseDeviceMa ...@@ -115,7 +115,7 @@ enterpriseDeviceManager.enableAdmin(wantTemp, enterpriseInfo, enterpriseDeviceMa
}); });
``` ```
## enterpriseDeviceManager.enableAdmin ## adminManager.enableAdmin
enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId?: number): Promise\<void> enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId?: number): Promise\<void>
...@@ -163,13 +163,13 @@ let enterpriseInfo = { ...@@ -163,13 +163,13 @@ let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
description: "enterprise description" description: "enterprise description"
} }
enterpriseDeviceManager.enableAdmin(wantTemp, enterpriseInfo, enterpriseDeviceManager.AdminType.ADMIN_TYPE_NORMAL, 100) adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_TYPE_NORMAL, 100)
.catch(error => { .catch(error => {
console.log("error occurs" + error); console.log("error occurs" + error);
}); });
``` ```
## enterpriseDeviceManager.disableAdmin ## adminManager.disableAdmin
disableAdmin(admin: Want, callback: AsyncCallback\<void>): void disableAdmin(admin: Want, callback: AsyncCallback\<void>): void
...@@ -203,7 +203,7 @@ let wantTemp = { ...@@ -203,7 +203,7 @@ let wantTemp = {
bundleName: "bundleName", bundleName: "bundleName",
abilityName: "abilityName", abilityName: "abilityName",
}; };
enterpriseDeviceManager.disableAdmin(wantTemp, error => { adminManager.disableAdmin(wantTemp, error => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -212,7 +212,7 @@ enterpriseDeviceManager.disableAdmin(wantTemp, error => { ...@@ -212,7 +212,7 @@ enterpriseDeviceManager.disableAdmin(wantTemp, error => {
}); });
``` ```
## enterpriseDeviceManager.disableAdmin ## adminManager.disableAdmin
disableAdmin(admin: Want, userId: number, callback: AsyncCallback\<void>): void disableAdmin(admin: Want, userId: number, callback: AsyncCallback\<void>): void
...@@ -247,7 +247,7 @@ let wantTemp = { ...@@ -247,7 +247,7 @@ let wantTemp = {
bundleName: "bundleName", bundleName: "bundleName",
abilityName: "abilityName", abilityName: "abilityName",
}; };
enterpriseDeviceManager.disableAdmin(wantTemp, 100, error => { adminManager.disableAdmin(wantTemp, 100, error => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -256,7 +256,7 @@ enterpriseDeviceManager.disableAdmin(wantTemp, 100, error => { ...@@ -256,7 +256,7 @@ enterpriseDeviceManager.disableAdmin(wantTemp, 100, error => {
}); });
``` ```
## enterpriseDeviceManager.disableAdmin ## adminManager.disableAdmin
disableAdmin(admin: Want, userId?: number): Promise\<void> disableAdmin(admin: Want, userId?: number): Promise\<void>
...@@ -296,12 +296,12 @@ let wantTemp = { ...@@ -296,12 +296,12 @@ let wantTemp = {
bundleName: "bundleName", bundleName: "bundleName",
abilityName: "abilityName", abilityName: "abilityName",
}; };
enterpriseDeviceManager.disableAdmin(wantTemp, 100).catch(error => { adminManager.disableAdmin(wantTemp, 100).catch(error => {
console.log("error occurs" + error); console.log("error occurs" + error);
}); });
``` ```
## enterpriseDeviceManager.disableSuperAdmin ## adminManager.disableSuperAdmin
disableSuperAdmin(bundleName: String, callback: AsyncCallback\<void>): void disableSuperAdmin(bundleName: String, callback: AsyncCallback\<void>): void
...@@ -332,7 +332,7 @@ disableSuperAdmin(bundleName: String, callback: AsyncCallback\<void>): void ...@@ -332,7 +332,7 @@ disableSuperAdmin(bundleName: String, callback: AsyncCallback\<void>): void
```js ```js
let bundleName = "com.example.myapplication"; let bundleName = "com.example.myapplication";
enterpriseDeviceManager.disableSuperAdmin(bundleName, error => { adminManager.disableSuperAdmin(bundleName, error => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -341,7 +341,7 @@ enterpriseDeviceManager.disableSuperAdmin(bundleName, error => { ...@@ -341,7 +341,7 @@ enterpriseDeviceManager.disableSuperAdmin(bundleName, error => {
}); });
``` ```
## enterpriseDeviceManager.disableSuperAdmin ## adminManager.disableSuperAdmin
disableSuperAdmin(bundleName: String): Promise\<void> disableSuperAdmin(bundleName: String): Promise\<void>
...@@ -377,12 +377,12 @@ disableSuperAdmin(bundleName: String): Promise\<void> ...@@ -377,12 +377,12 @@ disableSuperAdmin(bundleName: String): Promise\<void>
```js ```js
let bundleName = "com.example.myapplication"; let bundleName = "com.example.myapplication";
enterpriseDeviceManager.disableSuperAdmin(bundleName).catch(error => { adminManager.disableSuperAdmin(bundleName).catch(error => {
console.log("error occurs" + error); console.log("error occurs" + error);
}); });
``` ```
## enterpriseDeviceManager.isAdminEnabled ## adminManager.isAdminEnabled
isAdminEnabled(admin: Want, callback: AsyncCallback\<boolean>): void isAdminEnabled(admin: Want, callback: AsyncCallback\<boolean>): void
...@@ -414,7 +414,7 @@ let wantTemp = { ...@@ -414,7 +414,7 @@ let wantTemp = {
bundleName: "bundleName", bundleName: "bundleName",
abilityName: "abilityName", abilityName: "abilityName",
}; };
enterpriseDeviceManager.isAdminEnabled(wantTemp, (error, result) => { adminManager.isAdminEnabled(wantTemp, (error, result) => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -423,7 +423,7 @@ enterpriseDeviceManager.isAdminEnabled(wantTemp, (error, result) => { ...@@ -423,7 +423,7 @@ enterpriseDeviceManager.isAdminEnabled(wantTemp, (error, result) => {
}); });
``` ```
## enterpriseDeviceManager.isAdminEnabled ## adminManager.isAdminEnabled
isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\<boolean>): void isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\<boolean>): void
...@@ -448,7 +448,7 @@ let wantTemp = { ...@@ -448,7 +448,7 @@ let wantTemp = {
bundleName: "bundleName", bundleName: "bundleName",
abilityName: "abilityName", abilityName: "abilityName",
}; };
enterpriseDeviceManager.isAdminEnabled(wantTemp, 100, (error, result) => { adminManager.isAdminEnabled(wantTemp, 100, (error, result) => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -457,7 +457,7 @@ enterpriseDeviceManager.isAdminEnabled(wantTemp, 100, (error, result) => { ...@@ -457,7 +457,7 @@ enterpriseDeviceManager.isAdminEnabled(wantTemp, 100, (error, result) => {
}); });
``` ```
## enterpriseDeviceManager.isAdminEnabled ## adminManager.isAdminEnabled
isAdminEnabled(admin: Want, userId?: number): Promise\<boolean> isAdminEnabled(admin: Want, userId?: number): Promise\<boolean>
...@@ -487,14 +487,14 @@ let wantTemp = { ...@@ -487,14 +487,14 @@ let wantTemp = {
bundleName: "bundleName", bundleName: "bundleName",
abilityName: "abilityName", abilityName: "abilityName",
}; };
enterpriseDeviceManager.isAdminEnabled(wantTemp, 100).then((result) => { adminManager.isAdminEnabled(wantTemp, 100).then((result) => {
console.log("result is " + result); console.log("result is " + result);
}).catch(error => { }).catch(error => {
console.log("error occurs" + error); console.log("error occurs" + error);
}); });
``` ```
## enterpriseDeviceManager.isSuperAdmin ## adminManager.isSuperAdmin
isSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void isSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void
...@@ -515,7 +515,7 @@ isSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void ...@@ -515,7 +515,7 @@ isSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void
```js ```js
let bundleName = "com.example.myapplication"; let bundleName = "com.example.myapplication";
enterpriseDeviceManager.isSuperAdmin(bundleName, (error, result) => { adminManager.isSuperAdmin(bundleName, (error, result) => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -524,7 +524,7 @@ enterpriseDeviceManager.isSuperAdmin(bundleName, (error, result) => { ...@@ -524,7 +524,7 @@ enterpriseDeviceManager.isSuperAdmin(bundleName, (error, result) => {
}); });
``` ```
## enterpriseDeviceManager.isSuperAdmin ## adminManager.isSuperAdmin
isSuperAdmin(bundleName: String): Promise\<boolean> isSuperAdmin(bundleName: String): Promise\<boolean>
...@@ -550,96 +550,14 @@ isSuperAdmin(bundleName: String): Promise\<boolean> ...@@ -550,96 +550,14 @@ isSuperAdmin(bundleName: String): Promise\<boolean>
```js ```js
let bundleName = "com.example.myapplication"; let bundleName = "com.example.myapplication";
enterpriseDeviceManager.isSuperAdmin(bundleName).then((result) => { adminManager.isSuperAdmin(bundleName).then((result) => {
console.log("result is " + result); console.log("result is " + result);
}).catch(error => { }).catch(error => {
console.log("error occurs" + error); console.log("error occurs" + error);
}); });
``` ```
## enterpriseDeviceManager.getDeviceSettingsManager ## adminManager.setEnterpriseInfo
getDeviceSettingsManager(callback: AsyncCallback&lt;DeviceSettingsManager&gt;): void
获取DeviceSettingsManager对象,使用callback形式返回DeviceSettingsManager对象。
**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ----------------------------------- |
| callback | AsyncCallback<[DeviceSettingsManager](js-apis-enterpriseDeviceManager-DeviceSettingsManager.md)&gt; | 是 | callback方式返回DeviceSettingsManager对象 |
**错误码**
以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
| 类型 | 说明 |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | The application is not a administrator of the device. |
| 9200002 | The administrator application does not have permission to manage the device. |
**示例:**
```js
let wantTemp = {
bundleName: "bundleName",
abilityName: "abilityName",
};
enterpriseDeviceManager.getDeviceSettingsManager((error, mgr) => {
if (error != null) {
console.log("error code:" + error.code);
return;
}
mgr.setDateTime(wantTemp, 1526003846000, (error) => {
if (error != null) {
console.log("error code:" + error.code);
}
});
});
```
## enterpriseDeviceManager.getDeviceSettingsManager
getDeviceSettingsManager(): Promise&lt;DeviceSettingsManager&gt;
获取DeviceSettingsManager对象,使用Promise形式返回DeviceSettingsManager对象。
**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
**返回值:**
| 类型 | 说明 |
| ------------------------------------ | ---------------------------------- |
| Promise&lt;[DeviceSettingsManager](js-apis-enterpriseDeviceManager-DeviceSettingsManager.md)&gt; | Promise方式返回DeviceSettingsManager对象 |
**错误码**
以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
| 类型 | 说明 |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | The application is not a administrator of the device. |
| 9200002 | The administrator application does not have permission to manage the device. |
**示例:**
```js
let wantTemp = {
bundleName: "bundleName",
abilityName: "abilityName",
};
enterpriseDeviceManager.getDeviceSettingsManager().then((mgr) => {
mgr.setDateTime(wantTemp, 1526003846000).catch((error) => {
console.log("error code:" + error.code);
})
}).catch((error) => {
console.log("error code:" + error.code);
})
```
## enterpriseDeviceManager.setEnterpriseInfo
setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCallback\<void>;): void setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCallback\<void>;): void
...@@ -678,7 +596,7 @@ let enterpriseInfo = { ...@@ -678,7 +596,7 @@ let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
description: "enterprise description" description: "enterprise description"
} }
enterpriseDeviceManager.setEnterpriseInfo(wantTemp, enterpriseInfo, error => { adminManager.setEnterpriseInfo(wantTemp, enterpriseInfo, error => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -687,7 +605,7 @@ enterpriseDeviceManager.setEnterpriseInfo(wantTemp, enterpriseInfo, error => { ...@@ -687,7 +605,7 @@ enterpriseDeviceManager.setEnterpriseInfo(wantTemp, enterpriseInfo, error => {
}); });
``` ```
## enterpriseDeviceManager.setEnterpriseInfo ## adminManager.setEnterpriseInfo
setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise\<void>; setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise\<void>;
...@@ -731,12 +649,12 @@ let enterpriseInfo = { ...@@ -731,12 +649,12 @@ let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
description: "enterprise description" description: "enterprise description"
} }
enterpriseDeviceManager.setEnterpriseInfo(wantTemp, enterpriseInfo).catch(error => { adminManager.setEnterpriseInfo(wantTemp, enterpriseInfo).catch(error => {
console.log("error occurs" + error); console.log("error occurs" + error);
}); });
``` ```
## enterpriseDeviceManager.getEnterpriseInfo ## adminManager.getEnterpriseInfo
getEnterpriseInfo(admin: Want, callback: AsyncCallback&lt;EnterpriseInfo&gt;): void getEnterpriseInfo(admin: Want, callback: AsyncCallback&lt;EnterpriseInfo&gt;): void
...@@ -768,7 +686,7 @@ let wantTemp = { ...@@ -768,7 +686,7 @@ let wantTemp = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility", abilityName: "com.example.myapplication.MainAbility",
}; };
enterpriseDeviceManager.getEnterpriseInfo(wantTemp, (error, result) => { adminManager.getEnterpriseInfo(wantTemp, (error, result) => {
if (error != null) { if (error != null) {
console.log("error occurs" + error); console.log("error occurs" + error);
return; return;
...@@ -778,7 +696,7 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp, (error, result) => { ...@@ -778,7 +696,7 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp, (error, result) => {
}); });
``` ```
## enterpriseDeviceManager.getEnterpriseInfo ## adminManager.getEnterpriseInfo
getEnterpriseInfo(admin: Want): Promise&lt;EnterpriseInfo&gt; getEnterpriseInfo(admin: Want): Promise&lt;EnterpriseInfo&gt;
...@@ -815,7 +733,7 @@ let wantTemp = { ...@@ -815,7 +733,7 @@ let wantTemp = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility", abilityName: "com.example.myapplication.MainAbility",
}; };
enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => { adminManager.getEnterpriseInfo(wantTemp).then((result) => {
console.log(result.name); console.log(result.name);
console.log(result.description); console.log(result.description);
}).catch(error => { }).catch(error => {
...@@ -823,7 +741,7 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => { ...@@ -823,7 +741,7 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => {
}); });
``` ```
## enterpriseDeviceManager.subscribeManagedEvent ## adminManager.subscribeManagedEvent
subscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>, callback: AsyncCallback\<void>): void subscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>, callback: AsyncCallback\<void>): void
...@@ -851,14 +769,14 @@ let wantTemp = { ...@@ -851,14 +769,14 @@ let wantTemp = {
abilityName: "abilityName", abilityName: "abilityName",
}; };
let events = [0, 1]; let events = [0, 1];
enterpriseDeviceManager.subscribeManagedEvent(wantTemp, events, (error) => { adminManager.subscribeManagedEvent(wantTemp, events, (error) => {
if (error) { if (error) {
console.log("error code:" + error.code + " error message:" + error.message); console.log("error code:" + error.code + " error message:" + error.message);
} }
}); });
``` ```
## enterpriseDeviceManager.subscribeManagedEvent ## adminManager.subscribeManagedEvent
subscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>): Promise\<void> subscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>): Promise\<void>
...@@ -891,13 +809,13 @@ let wantTemp = { ...@@ -891,13 +809,13 @@ let wantTemp = {
abilityName: "abilityName", abilityName: "abilityName",
}; };
let events = [0, 1]; let events = [0, 1];
enterpriseDeviceManager.subscribeManagedEvent(wantTemp, events).then(() => { adminManager.subscribeManagedEvent(wantTemp, events).then(() => {
}).catch((error) => { }).catch((error) => {
console.log("error code:" + error.code + " error message:" + error.message); console.log("error code:" + error.code + " error message:" + error.message);
}) })
``` ```
## enterpriseDeviceManager.unsubscribeManagedEvent ## adminManager.unsubscribeManagedEvent
unsubscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>, callback: AsyncCallback\<void>): void unsubscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>, callback: AsyncCallback\<void>): void
...@@ -925,14 +843,14 @@ let wantTemp = { ...@@ -925,14 +843,14 @@ let wantTemp = {
abilityName: "abilityName", abilityName: "abilityName",
}; };
let events = [0, 1]; let events = [0, 1];
enterpriseDeviceManager.unsubscribeManagedEvent(wantTemp, events, (error) => { adminManager.unsubscribeManagedEvent(wantTemp, events, (error) => {
if (error) { if (error) {
console.log("error code:" + error.code + " error message:" + error.message); console.log("error code:" + error.code + " error message:" + error.message);
} }
}); });
``` ```
## enterpriseDeviceManager.unsubscribeManagedEvent ## adminManager.unsubscribeManagedEvent
unsubscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>): Promise\<void> unsubscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>): Promise\<void>
...@@ -965,7 +883,7 @@ let wantTemp = { ...@@ -965,7 +883,7 @@ let wantTemp = {
abilityName: "abilityName", abilityName: "abilityName",
}; };
let events = [0, 1]; let events = [0, 1];
enterpriseDeviceManager.unsubscribeManagedEvent(wantTemp, events).then(() => { adminManager.unsubscribeManagedEvent(wantTemp, events).then(() => {
}).catch((error) => { }).catch((error) => {
console.log("error code:" + error.code + " error message:" + error.message); console.log("error code:" + error.code + " error message:" + error.message);
}) })
......
# 设备设置管理 # 设备设置管理
本模块提供设备设置管理能力,包括设置时间等。仅企业设备管理员应用才能调用。 本模块提供设备设置管理能力,包括设置时间等。仅企业设备管理员应用才能调用。
> **说明**: > **说明**:
> >
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 使用说明 ## 导入模块
通过enterpriseDeviceManager中getDeviceSettingsManager方法获取。 ```js
import dateTimeManager from '@ohos.enterprise.dateTimeManager'
```js ```
import enterpriseDeviceManager from '@ohos.enterpriseDeviceManager'
## dateTimeManager.setDateTime
enterpriseDeviceManager.getDeviceSettingsManager((error, mgr) => {
if (error) { setDateTime(admin: Want, time: number, callback: AsyncCallback\<void>): void
console.log("error code:" + error.code + " error message:" + error.message);
return; 设置系统时间。使用callback异步回调。
}
let deviceMgr = mgr; **需要权限:** ohos.permission.ENTERPRISE_SET_DATETIME
});
``` **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
## DeviceSettingsManager.setDateTime **系统API**: 此接口为系统接口。
setDateTime(admin: Want, time: number, callback: AsyncCallback\<void>): void **参数:**
设置系统时间。使用callback异步回调。 | 参数名 | 类型 | 必填 | 说明 |
| ----- | ----------------------------------- | ---- | ------- |
**需要权限:** ohos.permission.ENTERPRISE_SET_DATETIME | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 |
| time | number | 是 | 时间戳(ms)。 |
**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager | callback | AsyncCallback\<void> | 是 | 回调函数。当系统时间设置成功err为null,否则为错误对象。 |
**系统API**: 此接口为系统接口。 **错误码**
**参数:** 以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
| 参数名 | 类型 | 必填 | 说明 | | 类型 | 说明 |
| ----- | ----------------------------------- | ---- | ------- | | ------- | ---------------------------------------------------------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 | | 9200001 | The application is not a administrator of the device. |
| time | number | 是 | 时间戳(ms)。 | | 9200002 | The administrator application does not have permission to manage the device. |
| callback | AsyncCallback\<void> | 是 | 回调函数。当系统时间设置成功err为null,否则为错误对象。 |
**示例:**
**错误码**
```js
以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) let wantTemp = {
bundleName: "bundleName",
| 类型 | 说明 | abilityName: "abilityName",
| ------- | ---------------------------------------------------------------------------- | };
| 9200001 | The application is not a administrator of the device. | dateTimeManager.setDateTime(wantTemp, 1526003846000, (error) => {
| 9200002 | The administrator application does not have permission to manage the device. | if (error) {
console.log("error code:" + error.code + " error message:" + error.message);
**示例:** }
})
```js ```
import enterpriseDeviceManager from '@ohos.enterpriseDeviceManager'
## dateTimeManager.setDateTime
let wantTemp = {
bundleName: "bundleName", setDateTime(admin: Want, time: number): Promise\<void>
abilityName: "abilityName",
}; 设置系统时间。使用Promise异步回调。
enterpriseDeviceManager.getDeviceSettingsManager((error, mgr) => {
if (error) { **需要权限:** ohos.permission.ENTERPRISE_SET_DATETIME
console.log("error code:" + error.code + " error message:" + error.message);
return; **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
}
mgr.setDateTime(wantTemp, 1526003846000, (error) => { **系统API**: 此接口为系统接口。
if (error) {
console.log("error code:" + error.code + " error message:" + error.message); **参数:**
}
}); | 参数名 | 类型 | 必填 | 说明 |
}); | ----- | ----------------------------------- | ---- | ------- |
``` | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 |
| time | number | 是 | 时间戳(ms)。 |
## DeviceSettingsManager.setDateTime
**返回值:**
setDateTime(admin: Want, time: number): Promise\<void>
| 类型 | 说明 |
设置系统时间。使用Promise异步回调。 | ----- | ----------------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**需要权限:** ohos.permission.ENTERPRISE_SET_DATETIME
**错误码**
**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
**系统API**: 此接口为系统接口。
| 类型 | 说明 |
**参数:** | ------- | ---------------------------------------------------------------------------- |
| 9200001 | The application is not a administrator of the device. |
| 参数名 | 类型 | 必填 | 说明 | | 9200002 | The administrator application does not have permission to manage the device. |
| ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 | **示例:**
| time | number | 是 | 时间戳(ms)。 |
```js
**返回值:** let wantTemp = {
bundleName: "bundleName",
| 类型 | 说明 | abilityName: "abilityName",
| ----- | ----------------------------------- | };
| Promise\<void> | Promise对象。无返回结果的Promise对象。 | dateTimeManager.setDateTime(admin, 1526003846000).then(() => {
}).catch((error) => {
**错误码** console.log("error code:" + error.code + " error message:" + error.message);
})
以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) ```
| 类型 | 说明 |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | The application is not a administrator of the device. |
| 9200002 | The administrator application does not have permission to manage the device. |
**示例:**
```js
import enterpriseDeviceManager from '@ohos.enterpriseDeviceManager'
let wantTemp = {
bundleName: "bundleName",
abilityName: "abilityName",
};
enterpriseDeviceManager.getDeviceSettingsManager().then((mgr) => {
mgr.setDateTime(wantTemp, 1526003846000).then(() => {
}).catch((error) => {
console.log("error code:" + error.code + " error message:" + error.message);
})
}).catch((error) => {
console.log("error code:" + error.code + " error message:" + error.message);
})
```
# 企业设备信息管理
本模块提供企业设备信息管理能力,包括获取设备序列号等。仅企业设备管理员应用才能调用。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import deviceInfo from '@ohos.enterprise.deviceInfo';
```
## deviceInfo.getDeviceSerial
getDeviceSerial(admin: Want, callback: AsyncCallback<string>): void
获取设备序列号,使用callback形式返回设备序列号。
**需要权限:** ohos.permission.ENTERPRISE_GET_DEVICE_INFO
**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
**系统API**: 此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| callback | AsyncCallback&lt;string&gt; | 是 | callback方式返回设备序列号 |
**错误码**
以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
| 类型 | 说明 |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | The application is not a administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
**示例:**
```js
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
deviceInfo.getDeviceSerial(wantTemp, (error, result) => {
if (error != null) {
console.log("error code:" + error.code + " error message:" + error.message);
return;
}
console.log(result);
});
```
## deviceInfo.getDeviceSerial
getDeviceSerial(admin: Want, callback: AsyncCallback<string>): void
获取设备序列号,使用callback形式返回设备序列号。
**需要权限:** ohos.permission.ENTERPRISE_GET_DEVICE_INFO
**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
**系统API**: 此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------------- |
| Promise&lt;string&gt; | Promise方式返回设备序列号 |
**错误码**
以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
| 类型 | 说明 |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | The application is not a administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
**示例:**
```js
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
deviceInfo.getDeviceSerial(wantTemp).then((result) => {
console.log(result);
}).catch(error => {
console.log("error code:" + error.code + " error message:" + error.message);
});
```
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册