deleteUserSetting

Deletes the user setting with the specified name (key). This removes the key and its value.

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
"keys" (required)	Array	The key of the user setting that is to be deleted.	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: Delete a user setting

Show ExampleHide Example

Goal: Create a deleteUserSetting action specifying a particular user setting to be deleted.

To achieve this the following code can be used:

{
  "type": "deleteUserSetting",
  "params": {
    "keys": [
      "isLoggedIn"
    ]
  }
}

The key parameter specifies the user setting to be deleted.