From b276f13d3fdbd3d1126a26c72d4f7b1ed01ebaad Mon Sep 17 00:00:00 2001 From: m0_75226990 Date: Wed, 1 Mar 2023 16:39:16 +0800 Subject: [PATCH] docs: update capture-screen.md --- docs/api/system/capture-screen.md | 55 +++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/docs/api/system/capture-screen.md b/docs/api/system/capture-screen.md index 7cfc8aa13..c8656f91c 100644 --- a/docs/api/system/capture-screen.md +++ b/docs/api/system/capture-screen.md @@ -44,3 +44,58 @@ Android的截屏监听原理是监听相册中截屏目录的文件新增,需 |属性 | 类型|说明| |-- |-- |-- | |回调函数| Function|用户主动截屏事件的回调函数| + + +### uni.setUserCaptureScreen(OBJECT) + +开启/关闭防截屏 + + +**平台差异说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|x|x|x|x|x|x|x| + +> 在 App 平台本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen) + +**OBJECT 参数说明** + +|参数名|类型|必填|说明| +|:-|:-|:-|:-| +|open|Boolean|是|是否打开防截屏| +|success|Function|否|接口调用成功的回调| +|fail|Function|否|接口调用失败的回调函数| +|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)| + +**返回参数说明** + +|参数|类型|说明| +|:-|:-|:-| +|errCode|Number|调用结果| +|errMsg|String|调用结果描述| +|errSubject|String|调用模块| + +**注意** + +iOS防截屏功能在iOS 13及以上系统支持。另外,因为系统原因,在iOS 15.1系统上会触发错误,因此该api在iOS 15.1系统上暂不可用。 + + +**代码示例** + +```javascript +let flag = this.setUserCaptureScreenFlag; +uni.setUserCaptureScreen({ + open: flag, + success: (res) => { + console.log("setUserCaptureScreen open: " + flag + " success: " + JSON.stringify(res)); + }, + fail: (res) => { + console.log("setUserCaptureScreen open: " + flag + " fail: " + JSON.stringify(res)); + }, + complete: (res) => { + console.log("setUserCaptureScreen open: " + flag + " complete: " + JSON.stringify(res)); + } +}); +``` + -- GitLab