跳到主要内容
版本：v6

@capacitor/device

Device API 提供了关于设备的内部信息，如型号和操作系统版本，以及用户信息如唯一标识符。

安装​

npm install @capacitor/device@latest-6
npx cap sync

苹果隐私清单要求​

为加强用户隐私保护，苹果现要求应用开发者在提交应用到 App Store Connect 时，必须声明 API 的使用目的。2024 年 5 月 1 日起，此项要求将强制执行。

使用本插件时，需在 /ios/App 目录下创建 PrivacyInfo.xcprivacy 文件，或使用 VS Code 扩展生成该文件，并指定使用理由。

具体操作步骤请参考 Capacitor 文档。

本插件需要使用字典键 NSPrivacyAccessedAPICategoryDiskSpace，推荐声明理由为 85F4.1。

示例 PrivacyInfo.xcprivacy 文件​

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>NSPrivacyAccessedAPITypes</key>
    <array>
      <!-- 如果隐私文件已存在，请将此字典项添加到数组 -->
      <dict>
        <key>NSPrivacyAccessedAPIType</key>
        <string>NSPrivacyAccessedAPICategoryDiskSpace</string>
        <key>NSPrivacyAccessedAPITypeReasons</key>
        <array>
          <string>85F4.1</string>
        </array>
      </dict>
    </array>
  </dict>
</plist>

插件使用示例​

import { Device } from '@capacitor/device';

const logDeviceInfo = async () => {
  const info = await Device.getInfo();

  console.log(info);
};

const logBatteryInfo = async () => {
  const info = await Device.getBatteryInfo();

  console.log(info);
};

API​

getId()​

getId() => Promise<DeviceId>

获取设备的唯一标识符。

返回值: 

Promise<DeviceId>

自: 1.0.0

getInfo()​

getInfo() => Promise<DeviceInfo>

获取底层设备/操作系统/平台的信息。

返回值: 

Promise<DeviceInfo>

自: 1.0.0

getBatteryInfo()​

getBatteryInfo() => Promise<BatteryInfo>

获取电池相关信息。

返回值: 

Promise<BatteryInfo>

自: 1.0.0

getLanguageCode()​

getLanguageCode() => Promise<GetLanguageCodeResult>

获取设备当前的语言区域代码。

返回值: 

Promise<GetLanguageCodeResult>

自: 1.0.0

getLanguageTag()​

getLanguageTag() => Promise<LanguageTag>

获取设备当前的语言区域标签。

返回值: 

Promise<LanguageTag>

自: 4.0.0

Interfaces​

DeviceId​

属性类型描述自
identifierstring应用可获取的设备标识符。在现代只允许获取应用安装 ID 的移动平台上，此标识符可能会变化。iOS 上，此标识符是 UUID，用于唯一标识设备给应用供应商（了解更多）。Android 8+ 上，标识符是一个 64 位数字（以十六进制字符串表示），对每个应用签名密钥、用户和设备的组合是唯一的（了解更多）。Web 上会生成随机标识符并存储在 localStorage 中供后续调用。如果 localStorage 不可用，则每次调用都会生成新的随机标识符。1.0.0

DeviceInfo​

属性类型描述自
namestring设备名称。例如"John 的 iPhone"。仅支持 iOS 和 Android 7.1 及以上版本。iOS 16+ 上需要相应权限才能返回真实设备名，否则返回通用名称。1.0.0
modelstring设备型号。例如"iPhone13,4"。1.0.0
platform'ios' | 'android' | 'web'设备平台（小写）。1.0.0
operatingSystem
OperatingSystem
设备操作系统。1.0.0
osVersionstring设备操作系统版本。1.0.0
iOSVersionnumberiOS 版本号。仅 iOS 可用。多部分版本号会被压缩为两位数的整数，例如 "16.3.1" → 1603015.0.0
androidSDKVersionnumberAndroid SDK 版本号。仅 Android 可用。5.0.0
manufacturerstring设备制造商。1.0.0
isVirtualboolean应用是否运行在模拟器/仿真器中。1.0.0
memUsednumber当前应用使用的近似内存大小，单位字节。除以 1048576 可得到 MB 数。1.0.0
diskFreenumber操作系统常规数据存储路径的可用磁盘空间，单位字节。Android 上返回核心 Android 操作系统所在"system"分区的可用空间。iOS 上此值不准确。1.0.0
diskTotalnumber操作系统常规数据存储路径的总大小，单位字节。Android 上返回核心 Android 操作系统所在"system"分区的总大小。1.0.0
realDiskFreenumber常规数据存储的可用磁盘空间，单位字节。1.1.0
realDiskTotalnumber常规数据存储路径的总大小，单位字节。1.1.0
webViewVersionstringWebView 浏览器版本1.0.0

BatteryInfo​

属性类型描述自
batteryLevelnumber电池电量百分比（0 到 1）。1.0.0
isChargingboolean设备是否正在充电。1.0.0

GetLanguageCodeResult​

属性类型描述自
valuestring两位语言代码。1.0.0

LanguageTag​

属性类型描述自
valuestring返回符合 IETF BCP 47 标准的语言标签。4.0.0

Type Aliases​

OperatingSystem​

'ios' | 'android' | 'windows' | 'mac' | 'unknown'

Contents

编辑此页