showLoadingOverlay

Displays a spinning loading indicator and overlay covering the whole screen to visualize activity and preventing user interaction for its duration.

note

The actual representation can vary due to the version of the operating system, launcher (Android) etc.

Field Configurations

Key	Type	Description	Default Value
"params"	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"maxTime"	Number,String	Time in seconds after which the overlay is hidden at the latest. If nothing is specified, the overlay remains as shown.	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: Show the loading overlay

Show ExampleHide Example

By default, the showLoadingOverlay action runs indefinetly. To disable it, use the maxTime key in the params or use the hideLoadingOverlay action.

{
  "type": "showLoadingOverlay",
  "params": {
    "maxTime": 5
  }
}