@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
接口
DeviceId
| 属性 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
uuid | string | 应用可用的设备 UUID。此标识符可能在现代移动平台上更改(这些平台仅允许每个应用安装的 UUID)。在 Web 上,会生成一个随机标识符并存储在 localStorage 中以供后续调用。 | 1.0.0 |
DeviceInfo
| 属性 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
name | string | 设备的名称。例如"John's iPhone"。仅支持 iOS 和 Android 7.1 及以上版本。 | 1.0.0 |
model | string | 设备型号。例如"iPhone"。 | 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 上,返回"system"分区(包含核心 Android 操作系统)的可用磁盘空间。在 iOS 上此值不准确。 | 1.0.0 |
diskTotal | number | 操作系统常规数据存储路径的总大小(字节)。在 Android 上,返回"system"分区(包含核心 Android 操作系统)的磁盘空间。 | 1.0.0 |
realDiskFree | number | 常规数据存储路径上的可用磁盘空间(字节)。 | 1.1.0 |
realDiskTotal | number | 常规数据存储路径的总大小(字节)。 | 1.1.0 |
webViewVersion | string | Web View 浏览器版本。 | 1.0.0 |
BatteryInfo
| 属性 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
batteryLevel | number | 电池充电量的百分比(0 到 1)。 | 1.0.0 |
isCharging | boolean | 设备是否正在充电。 | 1.0.0 |
GetLanguageCodeResult
| 属性 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
value | string | 两个字符的语言代码。 | 1.0.0 |
类型别名
OperatingSystem
'ios' | 'android' | 'windows' | 'mac' | 'unknown'