interface.uts

export type GetDeviceInfoOptions = {
  /**
   * @description 过滤字段的字符串数组，假如要获取指定字段，传入此数组。
   */
  filter: Array<string>
}

export type GetDeviceInfoResult = {
  /**
   * 设备品牌
   */
  brand?: string
  /**
   * 设备品牌
   */
  deviceBrand?: string,
  /**
   * 设备 id 。由 uni-app 框架生成并存储，清空 Storage 会导致改变
   */
  deviceId?: string,
  /**
   * 设备型号	
   */
  model?: string,
  /**
   * 设备型号	
   */
  deviceModel?: string,
  /**
   * 设备类型phone、pad、pc	
   */
  deviceType?: string,
  /**
   * 设备方向 竖屏 portrait、横屏 landscape	
   */
  deviceOrientation?: string,
  /**
   * 设备像素比	
   */
  devicePixelRatio?: string,
  /**
   * 操作系统及版本	
   */
  system?: string,
  /**
   * 客户端平台	
   */
  platform?: string,
  /**
   * oaid标识 Android专有
   * 
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *  		  	 "uniVer": "√",
   * 			 "unixVer": "√"
   *        },
   *        "ios": {
   *            "osVer": "9.0",
   *  		  	 "uniVer": "x",
   * 			 "unixVer": "x"
   *        }
   *    }
   * }
   */
  oaid?: string,
  /**
   * 是否root
   */
  isRoot?: boolean,
  /**
   * 是否是模拟器
   */
  isSimulator?: boolean,
  /**
   * adb是否开启
   * 
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *  		  	 "uniVer": "√",
   * 			 "unixVer": "√"
   *        },
   *        "ios": {
   *            "osVer": "9.0",
   *  		  	 "uniVer": "x",
   * 			 "unixVer": "x"
   *        }
   *    }
   * }
   */
  isUSBDebugging?: boolean,
  /**
   * idfa标识 iOS专有
   * 
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *  		  	 "uniVer": "x",
   * 			 "unixVer": "x"
   *        },
   *        "ios": {
   *            "osVer": "9.0",
   *  		  	 "uniVer": "√",
   * 			 "unixVer": "√"
   *        }
   *    }
   * }
   */
  idfa?: string,
  /**
   * 应用平台
   */
}


/**
 * @param [options=包含所有字段的过滤对象] 过滤的字段对象, 不传参数默认为获取全部字段。
 */
export type GetDeviceInfo = (options?: GetDeviceInfoOptions | null) => GetDeviceInfoResult;


export interface Uni {
  /**
    * GetDeviceInfo(Object object)
    * @description 
    * 获取设备信息
    * @param {GetDeviceInfoOptions} options [options=包含所有字段的过滤对象] 过滤的字段对象, 不传参数默认为获取全部字段。
    * @return {object}
    * @tutorial https://uniapp.dcloud.net.cn/api/system/getDeviceInfo.html
    * @uniPlatform {
    *    "app": {
    *        "android": {
    *            "osVer": "4.4",
    *  		  	 "uniVer": "√",
    * 			 "unixVer": "3.9+"
    *        },
    *        "ios": {
    *            "osVer": "9.0",
    *  		  	 "uniVer": "√",
    * 			 "unixVer": "3.9+"
    *        }
    *    }
    * }
    * @example
     ```typescript
      uni.getDeviceInfo({
        filter:[]
      })
     ```
    */
  getDeviceInfo(options?: GetDeviceInfoOptions | null): GetDeviceInfoResult;
}