文档管理中心
API参考快应用API系统能力截屏(1100+)

截屏(1100+)

接口声明

在manifest.json文件的 features属性中增加如下配置。

收起
自动换行
深色代码主题
复制
  1. {"name": "system.screenshot"}

导入模块

在调用接口页面的<script>部分增加如下配置。

收起
自动换行
深色代码主题
复制
  1. import screenshot from '@system.screenshot'

收起
自动换行
深色代码主题
复制
  1. var screenshot = require("@system.screenshot")

使用限制

展开

限制条件

说明

适用终端

手机、平板、智慧屏、车机

适用区域

全球

接口定义

展开

接口

描述

screenshot.onUserCaptureScreen(OBJECT)

监听用户截屏。

screenshot.offUserCaptureScreen()

取消监听用户截屏。

screenshot.onUserCaptureScreen(OBJECT)

描述

监听用户截屏。用户使用系统截屏、按键截屏、三指滑屏等方式时触发。

OBJECT参数

展开

参数

类型

是否必填

说明

callback

function

用户截屏后会回调此函数。

callback返回值

fail返回错误码

展开

错误码

说明

201

用户拒绝获取手机存储权限。

示例代码

收起
自动换行
深色代码主题
复制
  1. screenshot.onUserCaptureScreen({
  2. callback: function (data) {
  3. prompt.showToast({
  4. message: 'The user took a screenshot success',
  5. duration: "100000",
  6. gravity: 'center'
  7. })
  8. console.log('The user took a screenshot success!.')
  9. },
  10. fail:function (data,code) {
  11. prompt.showToast({
  12. message: 'The user took a screenshot fail',
  13. duration: "100000",
  14. gravity: 'center'
  15. })
  16. console.log('The user took a screenshot fail.')
  17. }
  18. })

screenshot.offUserCaptureScreen()

描述

取消监听用户截屏。

参数

示例代码

收起
自动换行
深色代码主题
复制
  1. screenshot.offUserCaptureScreen()

版本更新说明

展开

版本

发布日期

描述

1100

2022-07-07

第一次正式发布。

在 API参考 中进行搜索
请输入您想要搜索的关键词