search
开发文档
开发文档/小游戏开发/API/设备/剪贴板
剪贴板更新时间:2025-12-17 15:55:03

Clipboard

基础信息说明

功能概述:提供写入与读取系统剪切板文本内容的能力,支持回调结果处理

项目说明
版本要求
前提条件设备具备系统剪切板能力与必要权限
使用限制
相关教程

方法说明

方法名签名同步/异步说明
setClipboardDataqg.setClipboardData(object): void同步写入系统剪切板文本内容
getClipboardDataqg.getClipboardData(object): void异步回调读取系统剪切板文本内容,结果通过 success 回调返回

参数说明

qg.setClipboardData(object)

属性名类型必填说明
dataString要写入剪切板的文本内容
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

qg.getClipboardData(object)

属性名类型必填说明
successFunction成功回调,入参 { data: String },为当前剪切板文本内容
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

返回值说明

  • 所有方法均为无返回(void),通过参数中的回调获取结果

回调结果说明

回调成功
getClipboardData 成功回调参数

属性名类型说明
dataString当前剪切板文本内容

示例代码

// 设置剪切板内容
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)
}
})

注意事项

  • 某些设备或系统版本可能限制剪切板的读写行为,需确保具备相应权限。
  • 写入剪切板仅支持纯文本内容,若需要富文本或文件需使用系统原生能力。
上一篇:电量信息
下一篇:网络
文档内容是否有帮助?
有帮助
无帮助