setValueToUserSetting

Stores the provided value to a userSetting storage of the application.

note

UserSettings are stored within the device's persistent storage and will not be removed when the application is closed.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"key" (required)	String	The name of the user setting.	null
"value" (required)	String	The value of the user setting.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Set a value to a user setting

Show ExampleHide Example

Set the value for the specified user setting to the content of the textBox layer.

{
  "type": "setValueToUserSetting",
  "leadingDelimiter": "{$",
  "trailingDelimiter": "$}",
  "dynamicParams": {
    "userSetting01Actions01Value01": {
      "context": "form",
      "field": "userSetting01Actions01Value01"
    }
  },
  "params": {
    "key": "userSetting01Actions01Value01",
    "value": "{$userSetting01Actions01Value01$}"
  }
}