harmony 鸿蒙@system.device (Device Information)

2022-08-09
浏览 (553)

@system.device (Device Information)

The device module provides APIs for checking information about the current device.

NOTE

The APIs of this module are no longer maintained since API version 6. It is recommended that you use @ohos.deviceInfo instead.

The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import device from '@system.device';

device.getInfo

getInfo(options?: GetDeviceOptions): void

Obtains the device information.

NOTE

Do not call device.getInfo before the onShow event of the home page.

System capability: SystemCapability.Startup.SystemInfo.Lite

Parameters

Name	Type	Mandatory	Description
options	GetDeviceOptions	No	Parameters for obtaining the device information.

GetDeviceOptions

Defines the parameters for obtaining the device information.

System capability: SystemCapability.Startup.SystemInfo.Lite

Name	Type	Mandatory	Description
success	(data: DeviceResponse)=> void	No	Called when API call is successful. data indicates the returned device information. For details, see DeviceResponse.
fail	(data: any,code:number)=> void	No	Called when API call has failed. code indicates the error code returned upon a failure. code:200: Certain information could not be obtained.
complete	() => void	No	Called when API call is complete.

DeviceResponse

Provides the device information.

System capability: SystemCapability.Startup.SystemInfo.Lite

Name	Type	Description
brand	string	Brand.
manufacturer	string	Manufacturer.
model	string	Model.
product	string	Product number.
language⁴⁺	string	System language.
region⁴⁺	string	System region.
windowWidth	number	Window width.
windowHeight	number	Window height.
screenDensity⁴⁺	number	Screen density.
screenShape⁴⁺	string	Screen shape. The options are as follows: - rect: rectangular screen - circle: round screen
apiVersion⁴⁺	number	API version.
deviceType⁴⁺	string	Device type.

Example

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);            
      },        
    });    
  },
}