跳到主要内容
版本:v4

@capacitor/device

Device API 暴露关于设备的内部信息,例如型号和操作系统版本,以及用户信息如唯一标识。

安装

npm install @capacitor/device
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

属性类型描述自从
uuidstring设备在应用中可用的 UUID。在现代移动平台上,此标识符可能会发生变化,因为仅允许按应用安装的 UUID。在 Web 上,会生成一个随机标识符并存储在 localStorage 中以供后续调用。如果 localStorage 不可用,每次调用都会生成一个新的随机标识符。1.0.0

DeviceInfo

属性类型描述自从
namestring设备名称。例如"John's iPhone"。仅支持 iOS 和 Android 7.1 及以上版本。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
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'