uni.onUserCaptureScreen(callback?)
开启截屏监听
本 API 是 uni ext api，需下载插件：uni-usercapturescreen
onUserCaptureScreen 兼容性
| Web | 微信小程序 | Android | iOS |
|---|
| - | - | 3.9.0 | 4.11 |
参数
OnUserCaptureScreenCallbackResult 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|
| path | string | 否 | - | - | 截屏文件路径（仅Android返回） |
参见
uni.offUserCaptureScreen(callback?)
关闭截屏监听
本 API 是 uni ext api，需下载插件：uni-usercapturescreen
offUserCaptureScreen 兼容性
| Web | 微信小程序 | Android | iOS |
|---|
| - | - | 3.9.0 | 4.11 |
参数
OnUserCaptureScreenCallbackResult 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|
| path | string | 否 | - | - | 截屏文件路径（仅Android返回） |
参见
通用类型
GeneralCallbackResult
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|
| errMsg | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
|---|
| - | 4.41 | - | - |
| 错误信息 |
uni.setUserCaptureScreen(options)
设置防截屏
本 API 是 uni ext api，需下载插件：uni-usercapturescreen
setUserCaptureScreen 兼容性
| Web | 微信小程序 | Android | iOS 系统版本 | iOS |
|---|
| - | - | 3.9.0 | 13.0 | 4.11 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
|---|
| options | SetUserCaptureScreenOptions | 是 | - | - | |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|
| enable | boolean | 是 | - | - | true: 允许用户截屏 false: 不允许用户截屏，防止用户截屏到应用页面内容 | | success | (res: SetUserCaptureScreenSuccess) => void | 否 | - | - | uni.setUserCaptureScreen成功回调函数定义 | | fail | (res: IUniError) => void | 否 | - | - | uni.setUserCaptureScreen失败回调函数定义 | | complete | (res: any) => void | 否 | - | - | uni.setUserCaptureScreen完成回调函数定义 |
|
IUniError 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|
| errCode | number | 是 | - | - | 统一错误码 |
| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |
| data | any | 否 | - | - | 错误信息中包含的数据 |
| cause | Error | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |
| errMsg | string | 是 | - | - | - |
参见
通用类型
GeneralCallbackResult
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|
| errMsg | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
|---|
| - | 4.41 | - | - |
| 错误信息 |
tips
- 本文的截屏指手机自带的截屏事件的监听和取消监听，由用户操作手机按键触发。App平台如需通过代码对view截屏，另见API takeSnapshot
