Skip to main content
Version: 4.58

copyToClipboard

Copies the specified text to the clipboard of the user's device.

Field Configurations​

KeyTypeDescriptionDefault Value
"params" (required)Objectundefinednull

Parameters​

KeyTypeDescriptionDefault Value
"async"BooleanSpecifies whether the action should perform asynchronously.null
"text" (required)StringThe text to copy.null

Inherited​

From Base Action

Base Action

Field Configurations

KeyTypeDescriptionDefault Value
"dynamicParams"ObjectDynamic params to retrieve data from a specific context e.g. a userSetting.null
"leadingDelimiter"StringThe leading mustache delimiter to use.null
"params"Object,ArrayObject containing the properties of the action.null
"trailingDelimiter"StringThe trailing mustache delimiter to use.null
"type"StringType name of the action.null

Examples​

Example 1: Copy a text to the clipboard​

Goal: Create a copyToClipboard action copying the given text to the clipboard of the device.

To achieve this the following code can be used:

{
"type": "copyToClipboard",
"params": {
"text": "Copy this text."
}
}

The text parameter specifies the text to be copied to the device's clipboard.

Result:

Screencapture of the app showing the results of the sample code from Example 1.
A copyToClipboard action has been created.