跳到主要内容
版本: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
属性类型说明起始版本
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 操作系统的 "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

类型别名

OperatingSystem

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