• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.enterprise.deviceInfo（设备信息管理）
2<!--Kit: MDM Kit-->
3<!--Subsystem: Customization-->
4<!--Owner: @huanleima-->
5<!--Designer: @liuzuming-->
6<!--Tester: @lpw_work-->
7<!--Adviser: @Brilliantry_Rui-->
8
9本模块提供企业设备信息管理能力，包括获取设备序列号、设备名称等。
10
11> **说明：**
12>
13> 本模块首批接口从API version 12开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
14>
15> 本模块接口仅可在Stage模型下使用。
16>
17> 本模块接口仅对设备管理应用开放，且调用接口前需激活设备管理应用，具体请参考[MDM Kit开发指南](../../mdm/mdm-kit-guide.md)。
18
19## 导入模块
20
21```ts
22import { deviceInfo } from '@kit.MDMKit';
23```
24
25## deviceInfo.getDeviceInfo
26
27getDeviceInfo(admin: Want, label: string): string
28
29获取设备信息。
30
31**需要权限：** ohos.permission.ENTERPRISE_GET_DEVICE_INFO
32
33**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
34
35**模型约束：** 此接口仅可在Stage模型下使用。
36
37**参数：**
38
39| 参数名 | 类型                                                    | 必填 | 说明                                                         |
40| ------ | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
41| admin  | [Want](../apis-ability-kit/js-apis-app-ability-want.md) | 是   | 企业设备管理扩展组件。                                               |
42| label  | string                                                  | 是   | 支持获取的设备信息标签。<br/>- deviceName：设备名称。<br/>- deviceSerial：设备序列号。<br/>- simInfo：SIM卡信息。 <!--RP1--><!--RP1End-->|
43
44**返回值：**
45
46| 类型   | 说明                                                         |
47| ------ | ------------------------------------------------------------ |
48| string | 返回label对应的参数值。<br/>当label为simInfo时，返回值为表示SIM卡信息的JSON字符串。例如：[{"slotId": 0, "MEID": "", "IMSI": "", "ICCID": "", "IMEI": ""}, {"slotId": 1, "MEID": "", "IMSI": "", "ICCID": "", "IMEI": ""}]，其中：slotId:0表示卡槽1，slotId:1表示卡槽2。 |
49
50**错误码**：
51
52以下错误码的详细介绍请参见[企业设备管理错误码](errorcode-enterpriseDeviceManager.md)和[通用错误码](../errorcode-universal.md)。
53
54| 错误码ID | 错误信息                                                     |
55| -------- | ------------------------------------------------------------ |
56| 9200001  | The application is not an administrator application of the device. |
57| 9200002  | The administrator application does not have permission to manage the device. |
58| 201      | Permission verification failed. The application does not have the permission required to call the API. |
59| 401      | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
60
61**示例：**
62
63```ts
64import { deviceInfo } from '@kit.MDMKit';
65import { Want } from '@kit.AbilityKit';
66
67let wantTemp: Want = {
68  // 需根据实际情况进行替换
69  bundleName: 'com.example.myapplication',
70  abilityName: 'EntryAbility'
71};
72
73try {
74  // 需根据实际情况进行替换
75  let result: string = deviceInfo.getDeviceInfo(wantTemp, 'deviceName');
76  console.info(`Succeeded in getting device name, result : ${result}`);
77} catch (err) {
78  console.error(`Failed to get device name. Code: ${err.code}, message: ${err.message}`);
79}
80```
81