ActionsVersion: 4.55On this pageActions Actions represent user interactions with the application or what to do after triggering an event. They can be added to almost any layer to make it clickable and are then triggered by the user's touch. The actions added to a layer are executed one after the other in the order in which they were added. You can also specify how the app handles the result of another action. To this end, some actions can define an onSuccess and onError field in which an event can be named that is triggered after the action is completed. Depending on the action (e.g. the action request), the result data is added to the event as an event parameter. The type field of an action defines the type of the action and can also be referred to as its "name". The parameters of the action are entered in the params field of the JSON object. While most actions require parameters in order to be configured correctly, this is not the case for some. Exampleโ Example configuration of a showMessage action. { "actions": [ { "type": "showMessage", "params": { "text": "This will be displayed as a toast." } } ]} Index of all action typesโ Below is a complete list of all actions: ๐๏ธ addCalendarOpens the default calendar of the user's device and shows a pre-filled "add new event" view with the provided data. Depending on the operating system and its version, this could manifest as just an in-app overlay or a complete switch to the calendar app.๐๏ธ addContactOpens the contacts of the user's device and shows a pre-filled "add new contact" view with the provided data. Depending on the operating system and its version, this could manifest as just an in-app overlay or a complete switch to the contacts app.๐๏ธ addDataSourceThe addDataSource action enables you to add a new database (or just its source) to your application. This is used often if the desired source is not available at a previous point in you configuration or certain parts of the source are depending on not yet available data, i.e. before the user is logged in or got its credentials.๐๏ธ addGeofencesAdds a geofence too look for.๐๏ธ alertThis action triggers an alert in the form of the device's vibration and/or default notification sound.๐๏ธ askUserShows a modal pop-up with buttons in the style of the operating system. The lists of buttons and events reference each other so that the button with a specific index will trigger the corresponding event with the same index.๐๏ธ backInHistoryThis action triggers the back navigation of your view stack. As long as there is a view on your stack, the view is popped and the previous view is displayed.๐๏ธ beginNFCReadingStarts listening to NFC tags.๐๏ธ calibrateAccelerometerCalibrates the accelerometer (acceleration sensor).๐๏ธ callOpens the device's default phone app with the provided number pre-filled to be dialed.๐๏ธ cancelRequestCancels a request with a name. This will only guarantee, that the result of the request will be an error. If the request gets already processed by the server, a change on the server side may still occur.๐๏ธ cancelTimeoutCancels a previously set timeout action with the specified name.๐๏ธ checkBiometryOpens the device's system prompt for biometric authentication. Depending on the hardware capabilities, this can be (not limited to) fingerprint or face recognition, for example.๐๏ธ checkForInactivityFires an event after a specified period of inactivity. The counter is reset to the specified time with each interaction. Inactivity is considered to be no touch or other interaction by the user. Automatic changes (e.g. a gallery auto-swipe) do not interrupt the inactivity counter.๐๏ธ cleanGeofencesCleans all existing geofences.๐๏ธ clearCacheClears the cache of the app. The cached content primarily includes media files such as images, videos, or PDFs.๐๏ธ clearCustomStartResets the start configuration for the app, which then uses the default configuration for the next launch. This resets a previously set custom start point for the user, for example.๐๏ธ clearDatabaseResets the database data. By default, the data is retrieved again immediately.๐๏ธ clearFormValueDeletes a specific value from a form field/entry.๐๏ธ clearVariableClears a global variable.๐๏ธ closePopUpCloses the currently open pop-up.๐๏ธ closeViewField Configurations๐๏ธ closeWebSocketCloses a WebSocket.๐๏ธ copyToClipboardCopies text to the clipboard.๐๏ธ decodeJWTDecodes a JSON Web Token (JWT).๐๏ธ decryptSettingsWithBiometryDecrypts settings using the user's biometric data.๐๏ธ deleteAllLocalImagesDeletes all locally saved images.๐๏ธ deleteLocalImageDeletes a locally saved image.๐๏ธ deleteUserSettingDeletes a user setting.๐๏ธ disableCrashlyticsDisables Crashlytics and saves this decision.๐๏ธ disableTrackingTurns off tracking functionality. Matomo is used as the tracking framework.๐๏ธ downloadFileDownloads a file to the device's local storage.๐๏ธ downloadImageToGalleryDownloads an image to the device's local storage.๐๏ธ enableCrashlyticsEnables Crashlytics and saves this decision.๐๏ธ enableTrackingTurns on tracking functionality. Matomo is used as the tracking framework.๐๏ธ encryptSettingsWithBiometryEncrypts settings using the user's biometric data.๐๏ธ executePushPayloadExecutes a push notification payload by using it's ID.๐๏ธ executeQuerySQLExecutes an SQL query in the local database and makes the queried fields available in the parameters of the onSuccess action.๐๏ธ executeSQLExecutes an SQL command in the local database.๐๏ธ exportTableExports one or multiple tables from the app as a JSON file that can be reimported later using the importTable action.๐๏ธ fireEventFires the specified event.๐๏ธ forEachA for each expression.๐๏ธ getLocationGets the current location or address by reverse geocoding if necessary.๐๏ธ hideLoadingOverlayHides the loading overlay.๐๏ธ ifAn if expression.๐๏ธ importTableImports one or multiple tables to the app that have beed previously save as a JSON file using the exportTable action.๐๏ธ insertFromParamsInserts the given event Parameters into the SQLite database.๐๏ธ insertFromRequestInserts the response data into the SQLite database.๐๏ธ layerActionPerforms an action on another layer.๐๏ธ logLogs a message.๐๏ธ mailToSends an email and opens the device's email programm for this purpose.๐๏ธ noActionThis action can be used to block the user interaction from being propagting to the layer underneath or to ignore touch.๐๏ธ openAppSettingsOpens the system settings page of the app.๐๏ธ openBrowserOpens a URL in a custom tab or an external browser.๐๏ธ openWebSocketOpens a WebSocket.๐๏ธ openWifiSettingsOpens the WiFi system settings.๐๏ธ pauseAudioPauses the current audio playback (from playAudio action).๐๏ธ playAudioPlays an audio file.๐๏ธ playNotificationSoundPlays the default notification sound.๐๏ธ preloadLoad data to be accessed without a data connection. The data can be general files like PDFs or web content.๐๏ธ ratingAsk user to rate the app.๐๏ธ registerPushRegisters the app for push messages. A pop-up may appear before the registration (and thus the system message is displayed on iOS) takes place.๐๏ธ reloadDatabaseTableReloads the source of the database table.๐๏ธ removeDataSourceRemoves data source from a database table.๐๏ธ removeGeofencesField Configurations๐๏ธ removeLocalReminderField Configurations๐๏ธ replaceGeofencesField Configurations๐๏ธ requestPerforms HTTP request.๐๏ธ requestPermissionMakes requests for various permissions. It's important to note that how permissions work can vary depending on the operating system and its version.๐๏ธ resetFormResets the data of the current or specified form.๐๏ธ restartRestarts the app.๐๏ธ resumeAudioContinues audio playback.๐๏ธ returnThe return action breaks all following actions in the same action block.๐๏ธ revokePushThe revoke push action deletes the pushenabled user setting and unregister the app from the google and apple push service.๐๏ธ routeDisplays a route in a navigation app. If an address exists, longitude and latitude will be ignored. If there is no address, both parameters: latitude and longitude are needed.๐๏ธ saveImageLocallySaves a captured image to the local storage of the app.๐๏ธ sendFormMailPresents the e-mail client in the corresponding platform with predefined subject, body, and recipients addresses. form data of the current view can be used to construct the email body.๐๏ธ setCustomStartOverwrites the start configuration for the app. The app will use the provided configuration during the next launch.๐๏ธ setDataFromResultSets content to the given form from the form parameter or the current view's form.๐๏ธ setDelimitersSets the delimiters for the current list of actions.๐๏ธ setFormValueSets a form value. There are two different types of forms, such as named and unnamed. Named forms are stored in the memory and only persist until the application is fully closed, at which pooint they are removed. Unnamed forms are attached to the view where they are used and only persist until the view is destroyed, at which point they are removed.๐๏ธ setLocalReminderSets a local reminder.๐๏ธ setParamsSets values to the event parameters.๐๏ธ setTablePollingStateChanges the polling state of a table to retrieve data from the provided source.๐๏ธ setTimeoutExecutes actions at a later time.๐๏ธ setValueToUserSettingSets a user setting. User settings are stored on the device's persistent storage and are not removed even after the application is fully closed.๐๏ธ setVariableSets a global variable. Global variables are stored in the memory and only persist until the application is fully closed, at which point they are removed.๐๏ธ shareShares content like text, photos, files or links.๐๏ธ showBarcodeScannerShows a barcode scanner using device's camera.๐๏ธ showDebugViewDisplays a debug menu.๐๏ธ showLayoutDisplays the specified content on the specified layout.๐๏ธ showLoadingOverlayField Configurations๐๏ธ showMessageDisplays a message.๐๏ธ showViewDisplays the specified content on the specified layout.๐๏ธ startBeaconScanningStarts scanning for beacons.๐๏ธ startLocationTrackingStarts the location tracking of a device๐๏ธ stopAudioStops any audio that the app may be playing.๐๏ธ stopLocationTrackingTerminates the position determination with the specified keys.๐๏ธ stopNFCReadingStops listening to NFC tags.๐๏ธ submitFormSubmits the content of a form via HTTP request.๐๏ธ switchA switch expression. If none of the defined cases match _default case is executed.๐๏ธ switchStateChanges the state of a layer.๐๏ธ switchTabField Configurations๐๏ธ trackEventTracks an event in Firebase Analytics or Matomo.๐๏ธ validateFormValidates the fields of the specified form according to its defined validationExpression.
๐๏ธ addCalendarOpens the default calendar of the user's device and shows a pre-filled "add new event" view with the provided data. Depending on the operating system and its version, this could manifest as just an in-app overlay or a complete switch to the calendar app.
๐๏ธ addContactOpens the contacts of the user's device and shows a pre-filled "add new contact" view with the provided data. Depending on the operating system and its version, this could manifest as just an in-app overlay or a complete switch to the contacts app.
๐๏ธ addDataSourceThe addDataSource action enables you to add a new database (or just its source) to your application. This is used often if the desired source is not available at a previous point in you configuration or certain parts of the source are depending on not yet available data, i.e. before the user is logged in or got its credentials.
๐๏ธ alertThis action triggers an alert in the form of the device's vibration and/or default notification sound.
๐๏ธ askUserShows a modal pop-up with buttons in the style of the operating system. The lists of buttons and events reference each other so that the button with a specific index will trigger the corresponding event with the same index.
๐๏ธ backInHistoryThis action triggers the back navigation of your view stack. As long as there is a view on your stack, the view is popped and the previous view is displayed.
๐๏ธ cancelRequestCancels a request with a name. This will only guarantee, that the result of the request will be an error. If the request gets already processed by the server, a change on the server side may still occur.
๐๏ธ checkBiometryOpens the device's system prompt for biometric authentication. Depending on the hardware capabilities, this can be (not limited to) fingerprint or face recognition, for example.
๐๏ธ checkForInactivityFires an event after a specified period of inactivity. The counter is reset to the specified time with each interaction. Inactivity is considered to be no touch or other interaction by the user. Automatic changes (e.g. a gallery auto-swipe) do not interrupt the inactivity counter.
๐๏ธ clearCacheClears the cache of the app. The cached content primarily includes media files such as images, videos, or PDFs.
๐๏ธ clearCustomStartResets the start configuration for the app, which then uses the default configuration for the next launch. This resets a previously set custom start point for the user, for example.
๐๏ธ executeQuerySQLExecutes an SQL query in the local database and makes the queried fields available in the parameters of the onSuccess action.
๐๏ธ exportTableExports one or multiple tables from the app as a JSON file that can be reimported later using the importTable action.
๐๏ธ importTableImports one or multiple tables to the app that have beed previously save as a JSON file using the exportTable action.
๐๏ธ noActionThis action can be used to block the user interaction from being propagting to the layer underneath or to ignore touch.
๐๏ธ preloadLoad data to be accessed without a data connection. The data can be general files like PDFs or web content.
๐๏ธ registerPushRegisters the app for push messages. A pop-up may appear before the registration (and thus the system message is displayed on iOS) takes place.
๐๏ธ requestPermissionMakes requests for various permissions. It's important to note that how permissions work can vary depending on the operating system and its version.
๐๏ธ revokePushThe revoke push action deletes the pushenabled user setting and unregister the app from the google and apple push service.
๐๏ธ routeDisplays a route in a navigation app. If an address exists, longitude and latitude will be ignored. If there is no address, both parameters: latitude and longitude are needed.
๐๏ธ sendFormMailPresents the e-mail client in the corresponding platform with predefined subject, body, and recipients addresses. form data of the current view can be used to construct the email body.
๐๏ธ setCustomStartOverwrites the start configuration for the app. The app will use the provided configuration during the next launch.
๐๏ธ setDataFromResultSets content to the given form from the form parameter or the current view's form.
๐๏ธ setFormValueSets a form value. There are two different types of forms, such as named and unnamed. Named forms are stored in the memory and only persist until the application is fully closed, at which pooint they are removed. Unnamed forms are attached to the view where they are used and only persist until the view is destroyed, at which point they are removed.
๐๏ธ setTablePollingStateChanges the polling state of a table to retrieve data from the provided source.
๐๏ธ setValueToUserSettingSets a user setting. User settings are stored on the device's persistent storage and are not removed even after the application is fully closed.
๐๏ธ setVariableSets a global variable. Global variables are stored in the memory and only persist until the application is fully closed, at which point they are removed.
๐๏ธ validateFormValidates the fields of the specified form according to its defined validationExpression.