Skip to main content
Version: 4.56

Actions

Actions represent user interactions with the application or what to do after triggering an event. They can be added to almost any layer to make it clickable and are then triggered by the user's touch. The actions added to a layer are executed one after the other in the order in which they were added. You can also specify how the app handles the result of another action. To this end, some actions can define an onSuccess and onError field in which an event can be named that is triggered after the action is completed. Depending on the action (e.g. the action request), the result data is added to the event as an event parameter.

The type field of an action defines the type of the action and can also be referred to as its "name". The parameters of the action are entered in the params field of the JSON object. While most actions require parameters in order to be configured correctly, this is not the case for some.

Example​

Example configuration of a showMessage action.

{
  "actions": [
    {
      "type": "showMessage",
      "params": {
        "text": "This will be displayed as a toast."
      }
    }
  ]
}

Index of all action types​

Below is a complete list of all actions: