setClipboardData – Tuya MiniApp

setClipboardData(params: Object)

Requires:

BaseKit≥2.0.1@ray-js/ray≥0.3.23

Platforms:

iOSAndroid

import { setClipboardData } from '@ray-js/ray';

// Promise usage
try {
  const res = await setClipboardData({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Set the system clipboard content

Parameters

Property	Type	Required	Default	Description	BaseKit Since
`isSensitive`	boolean	No	`false`	Whether the content is sensitive true: yes; false: no; default is non-sensitive If sensitive, it can prevent sensitive content from appearing in any content preview shown in the clipboard copy visual confirmation on Android 13 and later Note: This property only applies to devices running Android 13 or later	v3.2.0
`data`	string	Yes	-	Clipboard content	-
`complete`	() => void	No	-	Completion callback (executed on both success and failure)	-
`success`	() => void	No	-	Callback on successful API call	-
`fail`	(params: Object) => void	No	-	Failure callback	-

fail callback parameters

Property	Type	Description
`errorMsg`	string	Error message
`errorCode`	string \| number	Error code
		Error extension

Return Value

None

Examples

import { setClipboardData } from '@ray-js/ray'

// Set system clipboard content (isSensitive marks whether the data is sensitive; effective on Android 13+ only)
setClipboardData({
  data: "Hello Tuya",
  isSensitive: false,
  success: () => console.log("Copied to clipboard"),
  fail: error => console.error(error),
});