openBrowser

Opens a website with the specified URL. Can be either within an internal browser overlaying the app or jumping out of the app context and using the user's default browser.

Field Configurations

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

Parameters

Key	Type	Description	Default Value
"alertMessage"	String	Message for the pop-up when exiting the app.	null
"alertTitle"	String	Title for the pop-up when exiting the app.	null
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"external"	Boolean,String	Opens the URL in the external browser.	null
"showAlert"	Boolean,String	Executes an askUser action before the URL is opened	true
"url" (required)	String	The URL to be opened.	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: Open a URL in the browser.

Goal: Create an openBrowser action.

The url parameter specifies the website that is to be opened.

{
  "type": "openBrowser",
  "params": {
    "url": "https://fabrik19.de",
    "external": true,
    "showAlert": true,
    "alertTitle": "You are leaving the app!",
    "alertMessage": "Are you sure you want to continue?"
  }
}

The alertTitle and alertMessage parameters set the text for the pop-up when exiting the app.

Result:

An openBrowser action has been created.