跳到主要内容
版本: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


接口

DeviceId

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

DeviceInfo

属性类型描述自从
namestring设备名称。例如"John's iPhone"。仅支持 iOS 和 Android 7.1 及以上版本。在 iOS 16+ 上,如果没有适当的 entitlements,将返回通用设备名称。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 操作系统所在"系统"分区的可用磁盘空间。在 iOS 上,此值不准确。1.0.0
diskTotalnumber操作系统正常数据存储路径的总大小,单位为字节。在 Android 上,返回核心 Android 操作系统所在"系统"分区的磁盘空间。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

类型别名

OperatingSystem

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