剪贴板更新时间:2025-12-17 15:55:03
Clipboard
基础信息说明
功能概述:提供写入与读取系统剪切板文本内容的能力,支持回调结果处理
| 项目 | 说明 |
| 版本要求 | 无 |
| 前提条件 | 设备具备系统剪切板能力与必要权限 |
| 使用限制 | 无 |
| 相关教程 | 无 |
方法说明
| 方法名 | 签名 | 同步/异步 | 说明 |
| setClipboardData | qg.setClipboardData(object): void | 同步 | 写入系统剪切板文本内容 |
| getClipboardData | qg.getClipboardData(object): void | 异步回调 | 读取系统剪切板文本内容,结果通过 success 回调返回 |
参数说明
qg.setClipboardData(object)
| 属性名 | 类型 | 必填 | 说明 |
| data | String | 是 | 要写入剪切板的文本内容 |
| success | Function | 否 | 接口调用成功的回调函数 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
qg.getClipboardData(object)
| 属性名 | 类型 | 必填 | 说明 |
| success | Function | 否 | 成功回调,入参 { data: String },为当前剪切板文本内容 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
返回值说明
- 所有方法均为无返回(void),通过参数中的回调获取结果
回调结果说明
回调成功
getClipboardData 成功回调参数
| 属性名 | 类型 | 说明 |
| data | String | 当前剪切板文本内容 |
示例代码
// 设置剪切板内容
qg.setClipboardData({
data: 'Hello Quick Game',
success() {
console.log('setClipboardData success')
},
fail(err) {
console.log('setClipboardData fail', err)
}
})
// 读取剪切板内容
qg.getClipboardData({
success(res) {
console.log('clipboard:', res.data)
},
fail(err) {
console.log('getClipboardData fail', err)
}
})注意事项
- 某些设备或系统版本可能限制剪切板的读写行为,需确保具备相应权限。
- 写入剪切板仅支持纯文本内容,若需要富文本或文件需使用系统原生能力。
上一篇:电量信息
下一篇:网络
文档内容是否有帮助?
有帮助
无帮助