跳到主要内容
版本: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
属性类型描述始于
namestring设备名称。例如 "John's 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
webViewVersionstringWeb 视图浏览器版本。1.0.0
属性类型描述自版本
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'