xref: /interface/sdk-js/api/@system.device.d.ts

/*
 * Copyright (c) 2020 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file
 * @kit BasicServicesKit
 */

/**
 * @interface DeviceResponse
 * @syscap SystemCapability.Startup.SystemInfo.Lite
 * @since 3
 */
export interface DeviceResponse {
  /**
   * Brand.
   *
   * @type { string }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   */
  brand: string;

  /**
   * Manufacturer.
   *
   * @type { string }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   */
  manufacturer: string;

  /**
   * Model.
   *
   * @type { string }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   */
  model: string;

  /**
   * Product number.
   *
   * @type { string }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   */
  product: string;

  /**
   * System language.
   *
   * @type { string }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 4
   */
  language: string;

  /**
   * System region.
   *
   * @type { string }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 4
   */
  region: string;

  /**
   * Window width.
   *
   * @type { number }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   */
  windowWidth: number;

  /**
   * Window Height.
   *
   * @type { number }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   */
  windowHeight: number;

  /**
   * Screen density.
   *
   * @type { number }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 4
   */
  screenDensity: number;

  /**
   * Screen shape. The options are as follows:
   * rect: Rectangle screen.
   * circle: Circle screen.
   *
   * @type { 'rect' | 'circle' }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 4
   */
  screenShape: 'rect' | 'circle';

  /**
   * API version.
   *
   * @type { number }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 4
   */
  apiVersion: number;

  /**
   * Device type. The options are as follows:
   * phone: smartphone
   * tablet: tablet
   * tv: smart TV
   * wearable: wearable
   * liteWearable: lite wearable
   * ar: AR
   * vr: virtual reality
   * earphones: headset
   * pc: personal computer
   * speaker: speaker
   * smartVision: smart visual device
   * linkIoT: connection module
   *
   * @type { string }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 4
   */
  deviceType: string;
}

/**
 * @interface GetDeviceOptions
 * @syscap SystemCapability.Startup.SystemInfo.Lite
 * @since 3
 */
export interface GetDeviceOptions {
  /**
   * Called when the device information is obtained.
   *
   * @type  { ?function } 
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   */
  success?: (data: DeviceResponse) => void;

  /**
   * Called when the device information fails to be obtained.
   *
   * @type { ?function }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   */
  fail?: (data: any, code: number) => void;

  /**
   * Called when the execution is completed.
   *
   * @type { ?function }
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   */
  complete?: () => void;
}

/**
 * getInfo interface
 *
 * @syscap SystemCapability.Startup.SystemInfo.Lite
 * @since 3
 */
export default class Device {
  /**
   * Obtains the device information.
   *
   * @param { GetDeviceOptions } options - Options
   * @syscap SystemCapability.Startup.SystemInfo.Lite
   * @since 3
   * @deprecated since 6
   */
  static getInfo(options?: GetDeviceOptions): void;
}