Skip to main content

openBrowser

Opens a URL in a custom tab or an external browser.

Field Configurations

KeyTypeDescriptionDefault Value
"params" (required)Objectundefinednull

Parameters

KeyTypeDescriptionDefault Value
"alertMessage"StringMessage for the pop-up when exiting the app.null
"alertTitle"StringTitle for the pop-up when exiting the app.null
"async"BooleanSpecifies whether the action should perform asynchronously.null
"external"Boolean,StringOpens the URL in the external browser.null
"showAlert"Boolean,StringExecutes an askUser action before the URL is openedtrue
"url" (required)StringThe URL to be opened.null

Inherited

From Base Action

Base Action

Field Configurations

KeyTypeDescriptionDefault Value
"dynamicParams"ObjectDynamic params to retrieve data from a specific context e.g. a userSetting.null
"leadingDelimiter"StringThe leading mustache delimiter to use.null
"params"Object,ArrayObject containing the properties of the action.null
"trailingDelimiter"StringThe trailing mustache delimiter to use.null
"type"StringType 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:

Screencapture of the app showing the results of the sample code from Example 1.
An openBrowser action has been created.