跳到主要内容
版本:v5

@capacitor/device

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

安装

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

示例

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"1603015ureth0.0
androidSDKVersionnumberAndroid SDK版本号。仅Android可用。5.0.0
manufacturerstring设备制造商。1.0.0
isVirtualboolean应用是否运行在模拟器/仿真器中。1.0.0
memUsednumber当前应用使用的近似内存(字节)。除以1048576可得到MB值。1.0.0
diskFreenumber操作系统常规数据存储路径的可用磁盘空间(字节)。
Android返回核心Android OS所在"system"分区的空闲空间。
iOS此值不准确。
1.0.0
diskTotalnumber操作系统常规数据存储路径的总大小(字节)。
Android返回核心Android OS所在"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'