js-apis-system-device.md 3.2 KB
Newer Older
1
# @system.device (设备信息)
Z
zengyawen 已提交
2

3 4
本模块提供当前设备的信息。

zyjhandsome's avatar
zyjhandsome 已提交
5 6
> **说明:**
>
Z
zengyawen 已提交
7
> - 从API Version 6开始,该接口不再维护,推荐使用新接口[`@ohos.deviceInfo`](js-apis-device-info.md)进行设备信息查询。
zyjhandsome's avatar
zyjhandsome 已提交
8
>
Z
zengyawen 已提交
9 10 11 12
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

## 导入模块

zyjhandsome's avatar
zyjhandsome 已提交
13
```typescript
Z
zengyawen 已提交
14 15 16 17 18
import device from '@system.device';
```

## device.getInfo

19
getInfo(options?: GetDeviceOptions): void
Z
zengyawen 已提交
20 21 22

获取当前设备的信息。

23
> **说明:**<br>
Z
zengyawen 已提交
24 25
> 在首页的onShow生命周期之前不建议调用device.getInfo接口。

26
**系统能力:** SystemCapability.Startup.SystemInfo
Z
zengyawen 已提交
27 28 29 30 31

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
32
| options | [GetDeviceOptions](#getdeviceoptions) | 否 | 定义设备信息获取的参数选项。 |
Z
zengyawen 已提交
33

34
## GetDeviceOptions
Z
zengyawen 已提交
35

36 37
定义设备信息获取的参数选项。

38
**系统能力:** SystemCapability.Startup.SystemInfo
39 40 41

| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
42
| success | (data:DeviceResponse)=> void | 否 | 接口调用成功的回调函数。 data为成功返回的设备信息,具体参考[DeviceResponse](#deviceresponse)。|
43 44 45 46 47 48 49
| fail | (data:any,code:number)=> void | 否 | 接口调用失败的回调函数。 code为失败返回的错误码。<br>code:200,表示返回结果中存在无法获得的信息。|
| complete | ()=> void | 否 | 接口调用结束的回调函数。 |

## DeviceResponse

设备信息。

50
**系统能力:** SystemCapability.Startup.SystemInfo
51 52

| 名称 | 类型 | 说明 |
Z
zengyawen 已提交
53 54 55 56 57 58 59 60 61 62 63 64 65
| -------- | -------- | -------- |
| brand | string | 品牌。 |
| manufacturer | string | 生产商。 |
| model | string | 型号。 |
| product | string | 代号。 |
| language<sup>4+</sup> | string | 系统语言。 |
| region<sup>4+</sup> | string | 系统地区。 |
| windowWidth | number | 可使用的窗口宽度。 |
| windowHeight | number | 可使用的窗口高度。 |
| screenDensity<sup>4+</sup> | number | 屏幕密度。 |
| screenShape<sup>4+</sup> | string | 屏幕形状。可取值:<br/>-&nbsp;rect:方形屏;<br/>-&nbsp;circle:圆形屏。 |
| apiVersion<sup>4+</sup> | number | 系统API版本号。 |
| releaseType<sup>4+</sup> | string | 版本发布类型,值为类型+版本号,如Beta1。<br/>类型可能值有:<br/>-&nbsp;Canary:同一apiVersion下,canary版本之间保持API兼容,beta版本不对canary版本兼容。<br/>-&nbsp;Beta:同一apiVersion下,beta版本之间保持API兼容,release版本不对beta版本兼容。<br/>-&nbsp;Release:release版本会保持5个API版本兼容。 |
Z
zengyawen 已提交
66
| deviceType<sup>4+</sup> | string | 设备类型。 |
Z
zengyawen 已提交
67 68 69 70


**示例:**

zyjhandsome's avatar
zyjhandsome 已提交
71
```typescript
Z
zengyawen 已提交
72 73 74 75 76 77 78 79 80 81 82 83 84
export default {    
  getInfo() {        
    device.getInfo({            
      success: function(data) {                
        console.log('Device information obtained successfully. Device brand:' + data.brand);            
      },            
      fail: function(data, code) {                
        console.log('Failed to obtain device information. Error code:'+ code + '; Error information: ' + data);            
      },        
    });    
  },
}
```