@system.device (Device Information)

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

NOTE

• Module maintenance strategy:

  - For lite wearables, this module is constantly maintained and available.

  - For other device types, this module is no longer maintained since API version 6, and you are advised to use @ohos.deviceInfo to query device information.

• 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^(deprecated)

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^(deprecated)

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 an API call is successful. data indicates the returned device information. For details, see DeviceResponse.
fail	(data: any,code:number)=> void	No	Called when an 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 an API call is complete.

DeviceResponse^(deprecated)

Defines 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.
language4+	string	System language.
region4+	string	System region.
windowWidth	number	Window width.
windowHeight	number	Window height.
screenDensity4+	number	Screen density.
screenShape4+	string	Screen shape. The options are as follows: - rect: rectangular screen - circle: round screen
apiVersion4+	number	API version.
deviceType4+	string	Device type.

Example

export default class Page {
  getInfo() {
    interface DeviceData {
      brand: string;
    }

    try {
      device.getInfo({
        success: (data: DeviceData) => {
          console.info('Device information obtained successfully. Device brand:' + data.brand);
        },
        fail: (data: string, code: number) => {
          console.info('Failed to obtain device information. Error code:' + code + '; Error information: ' + data);
        },
      });
    } catch (error) {
      console.error('Device information API is not supported');
    }
  }
}