tt.getClipboardData
收藏我的收藏
收藏基础库 1.0.0 开始支持本方法，这是一个异步方法。
获取系统剪贴板内容。基础库 2.53.0 开始,调用成功后,会弹出 toast 提示"已读取剪切板内容",持续 1.5s。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 在 success 回调中调用 tt.showToast 打开的 toast 可以覆盖接口默认打开的 toast。 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.getClipboardData(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| data | string | 数据 | 1.0.0 |
| errMsg | string | "getClipboardData:ok" | 1.0.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "getClipboardData:fail" + 详细错误信息 | 1.0.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 104301 | get clipboard failed | F | 小程序框架内部错误，有需要请创建工单咨询 | 1.0.0 |
| 104379 | api scope is not declared in the privacy agreement | D | 隐私权限配置不正确 请检查隐私协议配置是否正确 | 1.0.0 |
| 104383 | invalid scope | D | 权限配置不正确 请检查隐私协议配置是否正确 | 1.0.0 |
| 104383 | platform auth deny | D | 在小程序平台上不具备相应权 | 1.0.0 |
| 104390 | auth deny | U | 用户拒绝授权 用户未授予小程序授权，请引导用户按需授权，详情参考 用户授权 | 1.0.0 |
| 104391 | invokeFailed, intercept by ApiControl | F | 小程序框架内部错误，有需要请创建工单咨询 | 1.0.0 |
| 104394 | app in background | U | 当前小程序在后台，不能读取 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
