宇信科技-新一代移动金融开发平台YUMP

# Device

# getAppversion

获取当前使用的APP版本号

  • 支持平台
Android IOS HarmonyOS
√ √ √
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status String 调用状态码 0成功, 58001未授与电话权限(注:Android 锤子手机os厂商定制导致无法控制询问权限对话框，权限询问是在调用相应方法的时候os自动弹出
message String 调用结果信息
payload Object 回调结果
  • payload返回参数说明
参数名 类型 说明
versionName String app当前版本号
  • 示例代码

foxsdk.device.version(ret => {
    console.log('device/version===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
 });

# checkGpsOpen

检查gps服务是否开启。

参数说明

参数名 类型 必填 说明
data Object 可选 api参数直接传{}
completedCB Function 可选 请求完成回调函数，成功/失败都会触发

success 返回参数说明

参数 类型 说明
locationIsOpen string '1',系统定位开关打开,'0',系统定位开关关闭

示例

foxsdk.device.checkGpsOpen({},res => {
    console.log('app/checkGpsOpen===', JSON.stringify(res));
})

# getH5OffPkgsVersion

获取离线包版本号

  • 支持平台
Android IOS HarmonyOS
√ √ √
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status String 调用状态码 0成功
message String 调用结果信息
payload Object 回调结果
  • payload返回参数说明
参数名 类型 说明
offPkgs Object 离线包当前版本号
  • 示例代码

foxsdk.device.h5Version(ret => {
    console.log('h5Version/h5Version===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
 });

# getOrientation

获取应用横竖屏状态

  • 支持平台
Android IOS HarmonyOS
√ √ ×
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload Object 回调结果
  • payload返回参数说明
参数名 类型 说明
orientation Number 应用方向 0:未知; 1(头部向上),2(头部向下): 竖屏; 3(头部向右),4(头部向左): 横屏
  • 示例代码

foxsdk.device.getOrientation(ret => {
    console.log('device/getOrientation===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getSafeAreaInsets

获取应用的安全区域信息

  • 支持平台
Android IOS HarmonyOS
√ √ √
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload Object{safeAreaInsets} 回调结果{safeAreaInsets:以4个边为原点，向屏幕中间的距离}
  • safeAreaInsets返回参数说明
参数名 类型 说明
right Number 右边距离
top Number 顶部距离
left Number 左边距离
bottom Number 底部距离
isBottomBarShow Boolean 底部软按键是否显示，仅android返回
  • 示例代码

foxsdk.device.getSafeAreaInsets(ret => {
    console.log('device/getSafeAreaInsets===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getStatusbarHeight

获取应用的状态栏高度信息

  • 支持平台
Android IOS HarmonyOS
√ √ √
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload Object 回调结果，详见下表
  • payload返回参数说明
参数名 类型 说明
statusbarHeight Number 状态栏高度，单位px
  • 示例代码

foxsdk.device.getStatusbarHeight(ret => {
    console.log('device/getStatusbarHeight===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getStatusBarStyle

获取应用的状态栏样式信息

  • 支持平台
Android IOS HarmonyOS
√ √ √
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload Object 回调结果，详见下表
  • payload返回参数说明
参数名 类型 说明
style String light：白色文字 ，dark：（ios13支持暗黑模式）文字黑色（iOS 13新增暗黑模式 设置default 可能返回dark 也可能返回light ，不会再返回default。此时dark，light 指状态栏的文字色彩）
  • 示例代码

foxsdk.device.getStatusBarStyle(ret => {
    console.log('device/getStatusBarStyle===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getSystemInfo

获取系统信息

  • 支持平台
Android IOS HarmonyOS
√ √ √
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload Object 回调结果，详见下表
  • payload返回参数说明
参数名 类型 说明
language String 系统语言信息
name String 系统的名称
osvendor String 系统的供应商信息
version String 系统版本信息
height Number 屏幕高度物理分辨率
width Number 屏幕宽度物理分辨率
resolutionHeight Number 屏幕高度逻辑分辨率
resolutionWidth Number 屏幕宽度逻辑分辨率
scale Number 逻辑分辨率与物理分辨率的缩放比例
orientation Number 获取应用横竖屏状态
statusbarHeight Number 状态栏高度，单位px
safeAreaInsets Object 应用的安全区域{"bottom" : 34,"top" : 44,"right" : 0,"left" : 0，"isBottomBarShow":false},单位px,（isBottomBarShow底部软按键是否显示（此字段仅android支持，ios不返回此字段），当bottom的值大于0 ，false不显示，true显示，当bottom的值等于0 ，此值无意义）
vendor String 设备的生产厂商
model String 设备的型号
innerVersion String 客户端FOX运行环境的内部版本号
appid String 当前应用的APPID
packageId String 当前应用包名
appName String 客户端的应用名称
versionCode String 客户端构建版本号
launcher String 应用启动来源
arguments Object 第三方程序调用时传递给程序的参数
  • 示例代码

foxsdk.device.getSystemInfo(ret => {
    console.log('device/getSystemInfo===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getUUID

  • 支持平台
Android IOS HarmonyOS
√ √ √

获取应用的设备指纹-唯一标识信息 (ios该id 是系统自动生成，与通过其他工具所获取的uuid不一样)

  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload Object 回调结果，详见下表
  • payload返回参数说明
参数名 类型 说明
uuid String 设备唯一标识别
  • 示例代码

foxsdk.device.getUUID(ret => {
    console.log('device/getUUID===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getWifiOpenStatus

获取应用的wifi开启状态

  • 支持平台
Android IOS HarmonyOS
√ √ ×
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload Object 回调结果，详见下表
  • payload返回参数说明
参数名 类型 说明
wifiEnabled Boolean Wi-Fi开关是否打开 true：打开
  • 示例代码

foxsdk.device.getWifiOpenStatus(ret => {
    console.log('device/getWifiOpenStatus===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# setBadgeNumber

设置程手机序桌面快捷方式图标上显示的角标数字，（android 仅支持小米，华为，部分支持oppo，vivo)

  • 支持平台
Android IOS HarmonyOS
√ √ ×
  • 参数说明
参数名 类型 必填 说明
data Object 是 角标数字设置参数
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • data参数说明
参数名 类型 必填 说明
number Object 是 角标数(任意非负数字符串,传入"0",表示移除角标 )
options Object 可选 小米手机显示角标需要在系统消息中心显示一条通知，此参数用于设置通知的标题（title）和内容（content）
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码
message String 调用结果信息
payload Object 回调结果
  • 示例代码

var options = {"number": 1,"options":{"title":"消息的标题","content":"消息的内容"}};
foxsdk.device.setBadgeNumber(options,ret => {
    console.log('device/setBadgeNumber===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# setStatusBarStyle

设置顶部状态栏样式(电磁条部分)

  • 支持平台
Android IOS HarmonyOS
√ √ √
  • 参数说明
参数名 类型 必填 说明
data Object 是 状态栏样式
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • data参数说明
参数名 类型 必填 说明
style String 是 （style 的值：default：黑色字 light：白色字 dark：黑色字 ios13支持
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 1失败
message String 调用结果信息
  • 示例代码

foxsdk.device.setStatusBarStyle({"style" : 'default'},ret => {
    console.log('device/setStatusBarStyle===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getNavigationbarHeight

获取导航栏高度 (备注: ios 返回固定高度0)

  • 支持平台
Android IOS HarmonyOS
√ √ ×
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 1失败
message String 调用结果信息
payload Object 调用结果信息
  • payload返回参数说明
参数名 类型 说明
navigationbarHeight Number 导航栏栏高度
  • 示例代码

foxsdk.device.getNavigationbarHeight(ret => {
    console.log('device/getNavigationbarHeight===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});
Last Updated: 6/24/2024, 3:52:40 PM

← 屏幕 →