跳到主要内容
版本:v8

@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>

Since: 1.0.0


getInfo()

getInfo() => Promise<DeviceInfo>

返回关于底层设备/操作系统/平台的信息。

返回:

Promise<DeviceInfo>

Since: 1.0.0


getBatteryInfo()

getBatteryInfo() => Promise<BatteryInfo>

返回关于电池的信息。

返回:

Promise<BatteryInfo>

Since: 1.0.0


getLanguageCode()

getLanguageCode() => Promise<GetLanguageCodeResult>

获取设备当前的语言区域代码。

返回:

Promise<GetLanguageCodeResult>

Since: 1.0.0


getLanguageTag()

getLanguageTag() => Promise<LanguageTag>

获取设备当前的语言区域标签。

返回:

Promise<LanguageTag>

Since: 4.0.0


接口

DeviceId

属性类型描述Since
identifierstring应用可获取的设备标识符。在支持仅限每个应用安装 ID 的现代移动平台上,此标识符可能会发生变化。在 iOS 上,该标识符是一个 UUID,用于唯一标识设备到应用的供应商(阅读更多)。在 Android 8+ 上,该标识符是一个 64 位数字(以十六进制字符串表示),对于每个应用签名密钥、用户和设备的组合是唯一的(阅读更多)。在 Web 上,会生成一个随机标识符并存储在 localStorage 中供后续调用使用。如果 localStorage 不可用,则每次调用都会生成一个新的随机标识符。1.0.0

DeviceInfo

属性类型描述Since
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
webViewVersionstringWebView 浏览器版本。1.0.0

BatteryInfo

属性类型描述Since
batteryLevelnumber电池充电百分比的指示(0 到 1)。1.0.0
isChargingboolean设备是否正在充电。1.0.0

GetLanguageCodeResult

属性类型描述Since
valuestring两个字符的语言代码。1.0.0

LanguageTag

属性类型描述Since
valuestring返回格式良好的 IETF BCP 47 语言标签。4.0.0

类型别名

OperatingSystem

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