Skip to main content

setCustomStart

Overwrites the start configuration for the app. The app will use the provided configuration during the next launch.

Field Configurations

KeyTypeDescriptionDefault Value
"params" (required)ObjectThe parameters for the actionnull

Parameters

KeyTypeDescriptionDefault Value
"async"BooleanSpecifies whether the action should perform asynchronously.null
"baseUrl"StringThe base URL which the app should use to fetch the confignull
"secret"StringThe secret to use for the new base URL.null
"startConfig"StringThe start config."default"
"startConfigParams"ObjectThe start config parametersnull
"switchToCustomStart"BooleanThe app would restart if the value is true .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: setCustomStart

Goal: Change the baseurl, startConfig and restart the app with provided value.

{
"type": "setCustomStart",
"params": {
"baseUrl": "https://test.update.de/v1",
"startConfig": "startView",
"switchToCustomStart": true
}
}