upAppinfoModule app信息模块
模块概述
app信息模块为 H5 页面提供 appId,appKey,appVersion 等 app 相关信息。
方法列表
- getAppInfo(获取app信息)
- getPhoneInfo(获取当前手机型号信息)
- isGrayMode(获取灰度状态)
- setGrayMode(设置灰度状态)
- getApplicationCacheSize(获取缓存)
- cleanApplicationCache(清除缓存)
公共数据
- 所有数据均以 JSON 结构返回,由代码,信息和数据三部分组成
{ "retCode": "000000", //接口状态标识码 "retInfo": "执行成功",//接口信息说明 "retData": null //业务数据 }
具体定义:返回数据通用
模块变更记录
V3.0.0
- 新增方法:
- getAppInfo(获取app信息)
- 新增方法:
V3.2.0
- app信息模块未定义的retCode编码按照通用数据规定变为990001,操作失败retCode变为000001
V3.3.0
- 新增方法:
- getPhoneInfo(获取当前手机型号信息)
- getResourceInfo(获取资源包信息)
- 新增方法:
V3.4.0
- 删除方法:
- getResourceInfo(获取资源包信息)
- 删除方法:
V3.5.0
- 添加方法:
- isGrayMode(获取灰度状态)
- setGrayMode(设置灰度状态)
- 添加方法:
- V4.0.0
- 添加方法:
- getApplicationCacheSize(获取缓存)
- cleanApplicationCache(清除缓存)
- 添加方法:
方法说明
getAppInfo(获取app信息)
getAppInfo()
适用性
容器 | Nebula |
---|---|
支持情况 | 是 |
APP版本 | 6.12.0 及以上 |
params 输入参数:
无
错误返回 retCode说明:
按照通用
正确返回 retData说明:
属性名 | 数据类型 | 说明 |
---|---|---|
appId | String | 应用ID,Haier U+ 云平台全局唯一 |
appKey | String | 应用秘钥 |
appVerson | String | APP版本号 |
clientId | String | 客户端ID,从APP获取 |
haierClientId | String | 用户中心分配的clientId |
haierClientSecret | String | 用户中心分配的appSecret |
grayMode | Boolean | 当前是否灰度模式 |
env | String | 当前网络测试环境 |
isPreViewEnv | Boolean | 是否是预生产环境 |
platform | String | 手机系统,iOS or Android |
OSversion | String | 手机系统版本号(三段版本号形式) |
idfa | String | idfa码(此参数只在iOS下有值返回) |
testMode | Boolean | 当前是否测试模式 |
haierUserCenterUrl | String | 用户中心 |
示例
调用方式
uplusapi.upAppinfoModule.getAppInfo().then((result) =>console.log('result',result));
获取成功返回结果
{
"retCode": "000000",
"retInfo": "调用函数getAppInfoForAppInfo成功",
"retData": {
"appId": "MB-UZHSH-0001",
"appKey": "5dfca8714eb26e3a776e58a8273c8752",
"appVersion": "5.7.0",
"clientId": "CE3BAC1F-141F-4A01-A432-CE65C4184ACE",
"haierClientId": "uplusappios",
"haierClientSecret": "E46602789309498CEEDAACB585B00F40",
"grayMode": false,
"env": "联调",
"isPreViewEnv": "true",
"platform": "iOS",
"OSversion": "12.4.1",
"idfa": "52B3DCC8-B9D7-4B35-82AA-F5E18B62E138"
"testMode":false,
"haierUserCenterUrl": "http://www.haier.com/userCenter.html"
}
}
getPhoneInfo(获取app信息)
getPhoneInfo()
适用性
容器 | Nebula |
---|---|
支持情况 | 是 |
APP版本 | 6.12.0 及以上 |
params 输入参数:
无
错误返回 retCode说明:
按照通用
正确返回 retData说明:
属性名 | 数据类型 | 说明 |
---|---|---|
model | String | 型号 |
dpi | JSON | 设备宽高像素值包含x和y |
x | number | 宽度像素值 |
y | number | 高度像素值 |
示例
调用方式
uplusapi.upAppinfoModule.getPhoneInfo().then((result) =>console.log('result',result));
获取成功返回结果
{
"retCode": "000000",
"retInfo": "调用函数getPhoneInfoForAppInfo成功",
"retData": {
"model": "LYA-AL00",
"dpi": {
"x":750,
"y":1334
}
}
}
isGrayMode(获取灰度状态)
isGrayMode()
适用性
容器 | Nebula |
---|---|
支持情况 | 是 |
APP版本 | 6.12.0 及以上 |
params 输入参数:
无
错误返回 retCode说明:
按照通用
正确返回 retData说明:
无
示例
调用方式
uplusapi.upAppinfoModule.isGrayMode().then((result) =>console.log('result',result));
获取成功返回结果
{
"retCode": "000000",
"retInfo": "调用函数isGrayModeForAppInfo成功",
"retData": true
}
setGrayMode(获取灰度状态)
setGrayMode({params})
适用性
容器 | Nebula |
---|---|
支持情况 | 是 |
APP版本 | 6.12.0 及以上 |
params 输入参数:
属性名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
grayMode | Boolean | 是 | 新的灰度状态 |
错误返回 retCode说明:
按照通用
正确返回 retData说明:
无
示例
调用方式
uplusapi.upAppinfoModule.setGrayMode({grayMode:false}).then((result) =>console.log('result',result));
获取成功返回结果
{
"retCode": "000000",
"retInfo": "调用函数setGrayModeForAppInfo成功",
}
getApplicationCacheSize(获取缓存)
getApplicationCacheSize()
适用性
容器 | Nebula |
---|---|
支持情况 | 是 |
APP版本 | 6.12.0 及以上 |
params 输入参数:
无
错误返回 retCode说明:
按照通用
正确返回 retData说明:
无
示例
调用方式
uplusapi.upAppinfoModule.getApplicationCacheSize().then((result) =>console.log('result',result));
获取成功返回结果
{
"retCode": "000000",
"retInfo": "调用函数getCacheSizeForAppInfo成功",
"retData": 1028
}
cleanApplicationCache(清除缓存)
cleanApplicationCache()
适用性
容器 | Nebula |
---|---|
支持情况 | 是 |
APP版本 | 6.12.0 及以上 |
params 输入参数:
无
错误返回 retCode说明:
按照通用
正确返回 retData说明:
无
示例
调用方式
uplusapi.upAppinfoModule.cleanApplicationCache().then((result) =>console.log('result',result));
获取成功返回结果
{
"retCode": "000000",
"retInfo": "调用函数cleanCacheForAppInfo成功",
}