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

# Screen

# setScreenBrightness

设置屏幕亮度 (备注：范围是0-1.0)

  • 支持平台
Android IOS HarmonyOS
√ √ ×
  • 参数说明
参数名 类型 必填 说明
value Number 是 设置屏幕亮度的值（0.0~1.0）
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 失败请插件全局状态码
message String 调用结果信息
payload String 无
  • 示例代码
foxsdk.screen.setScreenBrightness(0.8, ret => {
    console.log('screen/setScreenBrightness===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getScreenBrightness

获取屏幕亮度

  • 支持平台
Android IOS HarmonyOS
√ √ ×
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 1：失败
message String 调用结果信息
payload Object 调用结果信息
  • payload返回参数说明
参数名 类型 说明
value Number 获取屏幕亮度的值(在0.0-1.0之间)
  • 示例代码

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

# setKeepScreenOn

设置是否保持常亮状态。仅在当前应用生效，离开应用后设置失效。

  • 支持平台
Android IOS HarmonyOS
√ √ ×
  • 参数说明
参数名 类型 必填 说明
keepScreenOn Boolean 是 设置屏幕常量的开关（true/false）
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 失败请查看全局状态码
message String 调用结果信息
payload String 无
  • 示例代码

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

# onUserCaptureScreen

监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件

  • 支持平台
Android IOS HarmonyOS
√ √ √
  • 参数说明
参数名 类型 必填 说明
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
global Number,Boolean 可选 全局标识 0/true:为全局监听即所有webview都监听，1/false/默认:为当前webview监听
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 1持续监听有截屏事件发生回调一次callback，失败请查看全局状态码
message String 调用结果信息
payload Object 无
  • 示例代码

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

# offUserCaptureScreen

移除截屏监听事件

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

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

# capture

针对当前webview截屏 （支持整屏截图与截长图）

  • 支持平台
Android IOS HarmonyOS
√ √ ×
  • 参数说明
参数名 类型 必填 说明
data Object 是 截屏参数
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • data参数说明
参数名 类型 必填 说明
isLong String 可选 是否滚动截屏,"0":只截取webview当前可见区域,"1":滚动截屏，会把该webview底部和顶部滑动后可见的内容区域都截出来，拼成一个长图返回。只有安卓支持滚动截屏。
path String 是 截图成功保存的文件路径(相对路劲),以暴露给前端的文件夹常量开头，以.png结尾,path必须在这些常量代表的文件夹之下: _www,_doc,_documents,_downloads
top Number 可选 单位为px像素,截取区域距离当前可见区域顶部的距离
left Number 可选 单位为px像素,截取区域距离当前可见区域左侧边的距离
right Number 可选 单位为px像素,截取区域距离当前可见区域右侧边的高度
bottom Number 可选 单位为px像素,截取区域距离当前可见区域底部的距离
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 1：失败
message String 调用结果信息
payload Object 调用结果信息
  • 示例代码

foxsdk.screen.capture({
    isLong: "0",
    path: '_downloads/test/test.png' 
},ret=>{
    console.log('screen/capture===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
})

# captureLongPic

IOS针对当前webview，截取已为手机端适配的web页面，截取纵向长图

  • 支持平台
Android IOS HarmonyOS
√ √ ×
  • 参数说明
参数名 类型 必填 说明
data Object 是 截屏参数
completedCB Function 可选 请求完成回调函数，成功/失败都会触发
  • data参数说明
参数名 类型 必填 说明
link String 是 有效的url链接，如果加载出正确的页面需要业务参数，把业务参数放在url后面
path String 是 截图成功保存的文件路径(相对路径),以暴露给前端的文件夹常量开头，以.png结尾,path必须在这些常量代表的文件夹之下: _www,_doc,_documents,_downloads
  • completedCB返回参数说明
参数名 类型 说明
status Number 调用状态码 0成功, 1：失败
message String 调用结果信息
payload Object 调用结果信息
  • 示例代码

foxsdk.screen.captureLongPic({
    link: "http://www.xxx.com?userId=1234&author=daefa",
    path: '_downloads/test/test.png' 
},ret=>{
    console.log('screen/captureLongPic===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
})

# disableScreenShot

禁止系统截屏

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

foxsdk.screen.disableScreenShot(ret=>{
    console.log('result: ' + ret);
})

# enableScreenShot

开启系统截屏

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

foxsdk.screen.enableScreenShot(ret=>{
    console.log('result: ' + ret);
})
Last Updated: 6/24/2024, 3:52:40 PM

← 扫码 →