From 04fa51cf552dc8f793a347a9e085e2c57c4c69f3 Mon Sep 17 00:00:00 2001 From: liwuli Date: Fri, 9 Dec 2022 11:17:46 +0800 Subject: [PATCH] add deviceInfo.md Signed-off-by: liwuli --- .../reference/apis/Readme-CN.md | 1 + .../apis/js-apis-enterprise-adminManager.md | 34 +-- .../js-apis-enterprise-dateTimeManager.md | 4 +- .../apis/js-apis-enterprise-deviceInfo.md | 286 ++++++++++++++++++ 4 files changed, 306 insertions(+), 19 deletions(-) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 153e151a20..39f267ac3d 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -290,6 +290,7 @@ - [@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)](js-apis-EnterpriseAdminExtensionAbility.md) - [@ohos.enterprise.adminManager (企业设备管理)](js-apis-enterprise-adminManager.md) - [@ohos.enterprise.dateTimeManager（系统时间管理）](js-apis-enterprise-dateTimeManager.md) + - [@ohos.enterprise.deviceInfo（设备信息管理）](js-apis-enterprise-deviceInfo.md) - 语言基础类库 - [@ohos.buffer (Buffer)](js-apis-buffer.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md index 7d398a3fb9..11b6b03333 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-adminManager.md @@ -28,7 +28,7 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callba | 参数名 | 类型 | 必填 | 说明 | | -------------- | ----------------------------------- | ---- | ------------------ | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | 是 | 设备管理员应用的企业信息 | | type | [AdminType](#admintype) | 是 | 激活的设备管理员类型 | | callback | AsyncCallback\ | 是 | callback方式返回是否激活成功 | @@ -79,7 +79,7 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId | 参数名 | 类型 | 必填 | 说明 | | -------------- | ----------------------------------- | ---- | ---------------------------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | 是 | 设备管理员应用的企业信息 | | type | [AdminType](#admintype) | 是 | 激活的设备管理员类型 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | @@ -131,7 +131,7 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId | 参数名 | 类型 | 必填 | 说明 | | -------------- | ----------------------------------- | ---- | ---------------------------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | 是 | 设备管理员应用的企业信息 | | type | [AdminType](#admintype) | 是 | 激活的设备管理员类型 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | @@ -185,7 +185,7 @@ disableAdmin(admin: Want, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | ---- | ------------------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 普通设备管理员应用 | | callback | AsyncCallback\ | 是 | callback方式返回是否去激活成功 | **错误码**: @@ -228,7 +228,7 @@ disableAdmin(admin: Want, userId: number, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | ---- | ---------------------------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 普通设备管理员应用 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | callback | AsyncCallback\ | 是 | callback方式返回是否去激活成功 | @@ -272,7 +272,7 @@ disableAdmin(admin: Want, userId?: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------------------- | ---- | ---------------------------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 普通设备管理员应用 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | **返回值：** @@ -396,7 +396,7 @@ isAdminEnabled(admin: Want, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | ---- | -------------------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | | callback | AsyncCallback\ | 是 | callback方式返回是否处于激活状态 | **示例**： @@ -429,7 +429,7 @@ isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\): | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | ---- | ---------------------------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | callback | AsyncCallback\ | 是 | callback方式返回是否处于激活状态 | @@ -463,7 +463,7 @@ isAdminEnabled(admin: Want, userId?: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------------------- | ---- | ---------------------------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | **返回值：** @@ -565,7 +565,7 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCa | 参数名 | 类型 | 必填 | 说明 | | -------------- | ----------------------------------- | ---- | ---------------------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | 是 | 设备管理员应用的企业信息 | | callback | AsyncCallback\; | 是 | callback方式返回是否设置企业信息成功 | @@ -613,7 +613,7 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise\; | 参数名 | 类型 | 必填 | 说明 | | -------------- | ----------------------------------- | ---- | ------------ | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | 是 | 设备管理员应用的企业信息 | **返回值：** @@ -660,7 +660,7 @@ getEnterpriseInfo(admin: Want, callback: AsyncCallback<EnterpriseInfo>): v | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------ | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | | callback | AsyncCallback<[EnterpriseInfo](#enterpriseinfo)> | 是 | callback方式返回设备管理员应用的企业信息 | **错误码**： @@ -702,7 +702,7 @@ getEnterpriseInfo(admin: Want): Promise<EnterpriseInfo> | 参数名 | 类型 | 必填 | 说明 | | ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | **返回值：** @@ -749,7 +749,7 @@ subscribeManagedEvent(admin: Want, managedEvents: Array\, callback | 参数名 | 类型 | 必填 | 说明 | | ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用。 | | managedEvents | Array\<[ManagedEvent](#managedevent)> | 是 | 订阅事件数组。 | | callback | AsyncCallback\ | 是 | 回调函数。当系统管理事件订阅成功err为null，否则为错误对象。 | @@ -793,7 +793,7 @@ subscribeManagedEvent(admin: Want, managedEvents: Array\): Promise | 参数名 | 类型 | 必填 | 说明 | | ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用。 | | managedEvents | Array\<[ManagedEvent](#managedevent)> | 是 | 订阅事件数组。 | **返回值：** @@ -841,7 +841,7 @@ unsubscribeManagedEvent(admin: Want, managedEvents: Array\, callba | 参数名 | 类型 | 必填 | 说明 | | ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用。 | | managedEvents | Array\<[ManagedEvent](#managedevent)> | 是 | 取消订阅事件数组。 | | callback | AsyncCallback\ | 是 | 回调函数。当系统管理事件取消订阅成功err为null，否则为错误对象。 | @@ -885,7 +885,7 @@ unsubscribeManagedEvent(admin: Want, managedEvents: Array\): Promi | 参数名 | 类型 | 必填 | 说明 | | ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用。 | | managedEvents | Array\<[ManagedEvent](#managedevent)> | 是 | 取消订阅事件数组。 | **返回值：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md index a38944747f..8124d4b10e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md @@ -28,7 +28,7 @@ setDateTime(admin: Want, time: number, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用。 | | time | number | 是 | 时间戳(ms)。 | | callback | AsyncCallback\ | 是 | 回调函数。当系统时间设置成功err为null，否则为错误对象。 | @@ -71,7 +71,7 @@ setDateTime(admin: Want, time: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用。 | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用。 | | time | number | 是 | 时间戳(ms)。 | **返回值：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md new file mode 100644 index 0000000000..f27db3d7b1 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md @@ -0,0 +1,286 @@ +# 设备信息管理 + +本模块提供企业设备信息管理能力，包括获取设备序列号等。仅企业设备管理员应用才能调用。 + +> **说明：** +> +> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```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-app-ability-want.md) | 是 | 设备管理员应用 | +| callback | AsyncCallback<string> | 是 | callback方式返回设备序列号 | + +**错误码**： + +以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) + +| 错误码ID | 错误信息 | +| ------- | ---------------------------------------------------------------------------- | +| 9200001 | the application is not an 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): Promise<string> + +获取设备序列号，使用callback形式返回设备序列号。 + +**需要权限：** ohos.permission.ENTERPRISE_GET_DEVICE_INFO + +**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager + +**系统API**: 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ----------------------------------- | ---- | ------- | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | ------------------------- | +| Promise<string> | Promise方式返回设备序列号 | + +**错误码**： + +以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) + +| 错误码ID | 错误信息 | +| ------- | ---------------------------------------------------------------------------- | +| 9200001 | the application is not an 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); +}); +``` + +## deviceInfo.getDisplayVersion + +getDisplayVersion(admin: Want, callback: AsyncCallback<string>): void; + +获取设备版本号，使用callback形式返回设备版本号。 + +**需要权限：** ohos.permission.ENTERPRISE_GET_DEVICE_INFO + +**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager + +**系统API**: 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------- | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | +| callback | AsyncCallback<string> | 是 | callback方式返回设备版本号 | + +**错误码**： + +以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) + +| 错误码ID | 错误信息 | +| ------- | ---------------------------------------------------------------------------- | +| 9200001 | the application is not an 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.getDisplayVersion(wantTemp, (error, result) => { + if (error != null) { + console.log("error code:" + error.code + " error message:" + error.message); + return; + } + console.log(result); +}); +``` + +## deviceInfo.getDisplayVersion + +getDisplayVersion(admin: Want): Promise<string> + +获取设备版本号，使用callback形式返回设备版本号。 + +**需要权限：** ohos.permission.ENTERPRISE_GET_DEVICE_INFO + +**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager + +**系统API**: 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ----------------------------------- | ---- | ------- | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | ------------------------- | +| Promise<string> | Promise方式返回设备版本号 | + +**错误码**： + +以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) + +| 错误码ID | 错误信息 | +| ------- | ---------------------------------------------------------------------------- | +| 9200001 | the application is not an 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.getDisplayVersion(wantTemp).then((result) => { + console.log(result); +}).catch(error => { + console.log("error code:" + error.code + " error message:" + error.message); +}); +``` + +## deviceInfo.getDeviceName + +getDeviceName(admin: Want, callback: AsyncCallback<string>): void + +获取设备名称，使用callback形式返回设备名称。 + +**需要权限：** ohos.permission.ENTERPRISE_GET_DEVICE_INFO + +**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager + +**系统API**: 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------- | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | +| callback | AsyncCallback<string> | 是 | callback方式返回设备名称 | + +**错误码**： + +以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) + +| 错误码ID | 错误信息 | +| ------- | ---------------------------------------------------------------------------- | +| 9200001 | the application is not an 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.getDeviceName(wantTemp, (error, result) => { + if (error != null) { + console.log("error code:" + error.code + " error message:" + error.message); + return; + } + console.log(result); +}); +``` + +## deviceInfo.getDeviceName + +getDeviceName(admin: Want): Promise<string> + +获取设备名称，使用callback形式返回设备名称。 + +**需要权限：** ohos.permission.ENTERPRISE_GET_DEVICE_INFO + +**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager + +**系统API**: 此接口为系统接口。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ----------------------------------- | ---- | ------- | +| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理员应用 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | ------------------------- | +| Promise<string> | Promise方式返回设备名称 | + +**错误码**： + +以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) + +| 错误码ID | 错误信息 | +| ------- | ---------------------------------------------------------------------------- | +| 9200001 | the application is not an 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.getDeviceName(wantTemp).then((result) => { + console.log(result); +}).catch(error => { + console.log("error code:" + error.code + " error message:" + error.message); +}); +``` \ No newline at end of file -- GitLab