剪贴板 API 平台差异说明

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快手小程序	京东小程序	元服务
√	√	√	√	√	√	√	√	√	x

uni.setClipboardData(OBJECT)

设置系统剪贴板的内容。

HarmonyOS Next 兼容性

HarmonyOS Next
HBuilderX 4.23

OBJECT 参数说明

参数名	类型	必填	说明	平台差异说明
data	String	是	需要设置的内容
showToast	Boolean	否	配置是否弹出提示，默认弹出提示	App (3.2.13+)、H5 (3.2.13+)
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

参数 HarmonyOS Next 兼容性

名称	HarmonyOS Next 兼容性
options	-
名称 HarmonyOS Next 兼容性 data - showToast - success - fail - complete -

示例

uni.setClipboardData({
	data: 'hello',
	success: function () {
		console.log('success');
	}
});

uni.getClipboardData(OBJECT)

获取系统剪贴板内容。

HarmonyOS Next 兼容性

HarmonyOS Next
HBuilderX 4.23

OBJECT 参数说明

参数名	类型	必填	说明
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

参数 HarmonyOS Next 兼容性

名称	HarmonyOS Next 兼容性
options	-
名称 HarmonyOS Next 兼容性 success - fail - complete -

GetClipboardDataSuccess 的属性值

名称	HarmonyOS Next 兼容性
data	-

success 返回参数说明

参数	类型	说明
data	String	剪贴板的内容

示例

uni.getClipboardData({
	success: function (res) {
		console.log(res.data);
	}
});

注意

• 设置剪贴板内容后，小程序平台会自动弹出轻提示；（微信小程序在成功回调success里设置toast可覆盖自带的轻提示）。App平台默认与小程序保持一致策略。如不希望在App平台弹出提示，可使用Native.js自行操作剪贴板，插件市场有封装好的示例https://ext.dcloud.net.cn/plugin?id=712。也可以在设置剪切板后立即uni.hideToast()。
• 如果小程序平台调用发现错误: setClipboardData:fail api scope is not declared in the privacy agreement, 原因是微信小程序于2023年9月15日更新剪切板为必须通过小程序后台配置用户隐私保护指引并审核通过后方可使用该API。
• HarmonyOS Next 平台使用时需要添加受限开放权限 ohos.permission.READ_PASTEBOARD