设备信息
接口声明
{ "name": "system.device" }
导入模块
import device from '@system.device' 或 const device = require('@system.device')
接口定义
device.getInfo(OBJECT)
获取设备信息
参数:
参数名 | 类型 | 必填 | 说明 |
---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
参数值 | 类型 | 说明 |
---|
brand | String | 设备品牌 |
manufacturer | String | 设备生产商 |
model | String | 设备型号 |
product | String | 设备代号 |
osType | String | 操作系统名称 |
osVersionName | String | 操作系统版本名称 |
osVersionCode | Integer | 操作系统版本号 |
platformVersionName | String | 运行平台版本名称 |
platformVersionCode | Integer | 运行平台版本号 |
language | String | 系统语言 |
region | String | 系统地区 |
screenWidth | Integer | 屏幕宽 |
screenHeight | Integer | 屏幕高 |
windowWidth 1030+ | Integer | 可使用窗口宽度 |
windowHeight 1030+ | Integer | 可使用窗口高度 |
statusBarHeight 1030+ | Integer | 状态栏高度 |
screenDensity 1040+ | Float | 设备的屏幕密度 |
示例:
device.getInfo({
success: function(ret) {
console.log(`handling success, brand = ${ret.brand}`)
}
})
device.getId(OBJECT)
批量获取设备标识,需要用户授权
权限要求
获取手机状态
参数:
参数名 | 类型 | 必填 | 说明 |
---|
type | Array | 是 | 支持 device、mac、user、advertising 1000+ 四种类型,可提供一至多个 |
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
按照传入的 type 返回对应的 id,未在 type 中出现的 id 类型不会返回
参数名 | 类型 | 说明 |
---|
device | String | 设备唯一标识。在 Android 上返回 IMEI 或 MEID |
mac | String | 设备的 mac 地址。在 Android M 及以上返回固定值:02:00:00:00:00:00 |
user | String | 用户唯一标识。在 Android 上返回 androidid |
advertising 1000+ | String | 广告唯一标识 |
fail 返回错误代码
示例:
device.getId({
type: ['device', 'mac'],
success: function(data) {
console.log(`handling success: ${data.device}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
device.getDeviceId(OBJECT) 1000+
获取设备唯一标识。需要用户授权
权限要求
获取手机状态
参数:
参数名 | 类型 | 必填 | 说明 |
---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
参数值 | 类型 | 说明 |
---|
deviceId | String | 设备唯一标识。在 Android 上返回 IMEI 或 MEID |
fail 返回错误代码
device.getDeviceId({
success: function(data) {
console.log(`handling success: ${data.deviceId}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
device.getUserId(OBJECT) 1000+
获取用户唯一标识
参数:
参数名 | 类型 | 必填 | 说明 |
---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
参数值 | 类型 | 说明 |
---|
userId | String | 设备唯一标识。在 Android 上返回 androidid |
device.getUserId({
success: function(data) {
console.log(`handling success: ${data.userId}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
device.getAdvertisingId(OBJECT) 1000+
获取广告唯一标识
参数:
参数名 | 类型 | 必填 | 说明 |
---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
参数值 | 类型 | 说明 |
---|
advertisingId | String | 广告唯一标识 |
device.getAdvertisingId({
success: function(data) {
console.log(`handling success: ${data.advertisingId}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
device.getSerial(OBJECT) 1040+
获取设备序列号
权限要求
获取手机状态
参数:
参数名 | 类型 | 必填 | 说明 |
---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
device.getSerial({
success: function(data) {
console.log(`handling success: ${data.serial}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
device.getTotalStorage(OBJECT) 1000+
获取存储空间的总大小
参数:
参数名 | 类型 | 必填 | 说明 |
---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
参数值 | 类型 | 说明 |
---|
totalStorage | Long | 存储空间的总大小,单位是 Byte。在 Android 上返回的是外部存储的总大小 |
device.getTotalStorage({
success: function(data) {
console.log(`handling success: ${data.totalStorage}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
device.getAvailableStorage(OBJECT) 1000+
获取存储空间的可用大小
参数:
参数名 | 类型 | 必填 | 说明 |
---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
参数值 | 类型 | 说明 |
---|
availableStorage | Long | 存储空间的可用大小,单位是 Byte。在 Android 上返回的是外部存储的可用大小 |
device.getAvailableStorage({
success: function(data) {
console.log(`handling success: ${data.availableStorage}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
device.getCpuInfo(OBJECT) 1000+
返回 CPU 信息
参数:
参数名 | 类型 | 必填 | 说明 |
---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
success 返回值:
参数值 | 类型 | 说明 |
---|
cpuInfo | String | CPU 信息。在 Android 上返回的是/proc/cpuinfo 文件的内容 |
device.getCpuInfo({
success: function(data) {
console.log(`handling success: ${data.cpuInfo}`)
},
fail: function(data, code) {
console.log(`handling fail, code = ${code}`)
}
})
同步方法获取平台版本信息
返回值:
返回 platform 对象,包含下列属性
属性 | 类型 | 说明 |
---|
versionName | String | 运行平台版本名称 |
versionCode | Integer | 运行平台版本号 |
示例:
var device = require('@system.device')
var platform = device.platform
var versionName = platform.versionName
var versionCode = platform.versionCode
后台运行限制
无限制。后台运行详细用法参见后台运行 脚本。