@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
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
uuid | string | 应用程序可访问的设备 UUID。此标识符在仅允许按应用安装 UUID 的现代移动平台上可能会发生变化。在 Web 端,会生成一个随机标识符并存储在 localStorage 中供后续调用使用。如果 localStorage 不可用,则每次调用都会生成一个新的随机标识符。 | 1.0.0 |
| 属性 | 类型 | 说明 | 起始版本 |
|---|---|---|---|
name | string | 设备名称。例如 "John's iPhone"。仅在 iOS 和 Android 7.1 或更高版本上支持。 | 1.0.0 |
model | string | 设备型号。例如 "iPhone13,4"。 | 1.0.0 |
platform | 'ios' | 'android' | 'web' | 设备平台(小写)。 | 1.0.0 |
operatingSystem | | 设备的操作系统。 | 1.0.0 |
osVersion | string | 设备操作系统的版本。 | 1.0.0 |
manufacturer | string | 设备制造商。 | 1.0.0 |
isVirtual | boolean | 应用是否运行在模拟器/仿真器中。 | 1.0.0 |
memUsed | number | 当前应用大致使用的内存,单位为字节。除以 1048576 可得到以 MB 为单位的使用量。 | 1.0.0 |
diskFree | number | 操作系统常规数据存储路径上的可用磁盘空间,单位为字节。在 Android 上,返回存放核心 Android 操作系统的 "system" 分区的可用磁盘空间。在 iOS 上,此值不准确。 | 1.0.0 |
diskTotal | number | 操作系统常规数据存储路径的总大小,单位为字节。在 Android 上,返回存放核心 Android 操作系统的 "system" 分区的磁盘空间大小。 | 1.0.0 |
realDiskFree | number | 常规数据存储上的可用磁盘空间,单位为字节。 | 1.1.0 |
realDiskTotal | number | 常规数据存储路径的总大小,单位为字节。 | 1.1.0 |
webViewVersion | string | WebView 浏览器版本。 | 1.0.0 |
BatteryInfo
| 属性 | 类型 | 说明 | 起始版本 |
|---|---|---|---|
batteryLevel | number | 表示电池电量的百分比(0 到 1)。 | 1.0.0 |
isCharging | boolean | 设备是否正在充电。 | 1.0.0 |
GetLanguageCodeResult
| 属性 | 类型 | 说明 | 起始版本 |
|---|---|---|---|
value | string | 两位字符的语言代码。 | 1.0.0 |
LanguageTag
| 属性 | 类型 | 说明 | 起始版本 |
|---|---|---|---|
value | string | 返回符合规范的 IETF BCP 47 语言标签。 | 4.0.0 |
类型别名
OperatingSystem
'ios' | 'android' | 'windows' | 'mac' | 'unknown'