askUser

Shows a modal pop-up with buttons in the style of the operating system. The lists of buttons and events or actions reference each other so that the button with a specific index will trigger the corresponding event or action with the same index.

note

If no buttons are defined, an "OK" is displayed by default to confirm and close the modal pop-up.

Field Configurations

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

Parameters

Key	Type	Description	Default Value
"actions"	Array	A list of actions that are fired when the button with the same index is clicked.	null
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"buttons"	Array	A list of texts that are displayed as buttons.	null
"events"	Array	A list of events that are fired when the button with the same index is clicked.	null
"isCancelable"	Boolean,String	Indicates whether the pop up can be closed by clicking outside the pop up or via the Back button.	false
"message"	String	The text of the pop up.	null
"onCancel"	String	This event is fired on cancellation.	null
"title"	String	The title of the pop up.	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: Create an askUser action using events

Goal: Create an askUser action with two options and correlating events.

In this case, the event nothingPicked is fired on cancellation.

{
  "type": "askUser",
  "params": {
    "title": "Leave the Matrix?",
    "message": "Take a pill",
    "isCancelable": true,
    "onCancel": "nothingPicked",
    "buttons": [
      "Red Pill",
      "Blue Pill"
    ],
    "events": [
      "pickedRed",
      "pickedBlue"
    ]
  }
}

The button list can contain simple strings or objects with the fields:

• label: text on the button
• image: image on the left side of the button

Result:

Example 2: Create an askUser action using actions

Goal: Create an askUser action with two options and correlating actions.

The actions are placed in an array of arrays.

{
  "type": "askUser",
  "params": {
    "title": "An error occured",
    "message": "Do you want to report the error?",
    "isCancelable": true,
    "onCancel": "nothingPicked",
    "buttons": [
      "Yes",
      "No"
    ],
    "actions": [
      [
        {
          "type": "backInHistory",
          "params": {
            "steps": "-1"
          }
        },
        {
          "type": "mailTo",
          "params": {
            "to": "support@mail.com",
            "subject": "Feedback: Error report",
            "content": ""
          }
        }
      ],
      [
        {
          "type": "backInHistory",
          "params": {
            "steps": "-1"
          }
        }
      ]
    ]
  }
}

More than one action can be tied to each button.

Result:

An askUser action has been created.