ActionsVersion: 4.57On 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 or actions reference each other so that the button with a specific index will trigger the corresponding event or action 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.๐๏ธ clearVariableResets the value of a previously defined variable to null.๐๏ธ closePopUpCloses the currently open pop-up on the view stack. If no pop-up is present, nothing happens.๐๏ธ closeViewCloses a previously created, named view.๐๏ธ closeWebSocketCloses a previously opened WebSocket connection with the specified name.๐๏ธ copyToClipboardCopies the specified text to the clipboard of the user's device.๐๏ธ decodeJWTDecodes a JSON Web Token (JWT).๐๏ธ decryptSettingsWithBiometryDecrypts a value that was previously encrypted with personal biometric information. Uses the options available on the users device and operating system.๐๏ธ deleteAllLocalImagesDeletes all locally saved images of this application.๐๏ธ deleteLocalImageDeletes a locally saved image with the specified name from the apps image folder on the device.๐๏ธ deleteUserSettingDeletes the user setting with the specified name (key). This removes the key and its value.๐๏ธ disableCrashlyticsDisables the collection of crash and similar data by Google Firebase Crashlytics.๐๏ธ disableTrackingTurns off tracking of user interactions for analytical purposes.๐๏ธ downloadFileDownloads a file to the device's local storage.๐๏ธ downloadImageToGalleryDownloads an image to the device's local storage.๐๏ธ enableCrashlyticsEnables the collection of crash and similar data by Google Firebase Crashlytics.๐๏ธ enableTrackingActivates tracking of user interactions for analytical purposes.๐๏ธ encryptSettingsWithBiometryEncrypts a value with personal biometric information. Uses the options available on the users device and operating system.๐๏ธ 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 to loop through a list. Elements can be items of an array or keyed objects of a list.๐๏ธ getLocationGets the current location or address by reverse geocoding if necessary.๐๏ธ hideLoadingOverlayHides the loading overlay within the app once.๐๏ธ ifAn if expression to call different actions depending on whether the condition is met or not.๐๏ธ importTableImports one or multiple tables to the app that have beed previously save as a JSON file using the exportTable action.๐๏ธ insertFromParamsInserts data given via event parameters into the SQLite database of the application.๐๏ธ insertFromRequestCombines the functionality of the request and insertFromParams actions into one, therefore requesting data which is then inserted into a database table of the application.๐๏ธ layerActionPerforms an action on another layer.๐๏ธ logLogs a message with the desired log level. This message can then be used for debug purposes within the debug menu of the application.๐๏ธ mailToOpens the device's default e-mail app and pre-fills the inputs with the provided data to send an e-mail.๐๏ธ noActionCan be used to prevent a touch interaction to be propagated through the layers, e.g. to disable a button.๐๏ธ openAppSettingsOpens the system settings page of this specific app.๐๏ธ openBrowserOpens 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.๐๏ธ openWebSocketOpens a WebSocket connection to a service in order to receive messages from it and react to them.๐๏ธ openWifiSettingsOpens the WiFi system settings.๐๏ธ pauseAudioPauses the current audio playback triggerd by the playAudio action.๐๏ธ playAudioPlays the audio file specified by the URL.๐๏ธ playNotificationSoundPlays the default notification sound set by the user within the operating system.๐๏ธ preloadLoads data to be stored within the system storage of the app to ensure functionality or data access without a data connection. Ususally this includes files like media files (images, videos), PDFs or web content.๐๏ธ ratingPrompts the user to rate the application using the system's native default rating overlay without leaving the app itself.๐๏ธ registerPushRegisters the app with FCM (Android) or APNS (iOS) for push messages. A system prompt may appear for the user to confirm receiving notifications from this app before the actual registration concludes.๐๏ธ reloadDatabaseTableRequest the data source of the specified database table manually and inserts the received data.๐๏ธ removeDataSourceRemoves data source from a database table with the specified name.๐๏ธ removeGeofencesField Configurations๐๏ธ removeLocalReminderField Configurations๐๏ธ replaceGeofencesField Configurations๐๏ธ requestPerforms an HTTP request.๐๏ธ requestPermissionRequests desired permissions to access guarded system resources like camera, position, etc. Depending on the operating system and version, this can result in a system prompt asking the user to accept or prevent this access.๐๏ธ resetFormResets the form with the specified name. All form values of this form will be removed.๐๏ธ restartManually restarts the app. Non-volatile data will be kept.๐๏ธ resumeAudioContinues the audio playback of a previously paused playback by pauseAudio.๐๏ธ returnThe return action breaks all following actions in the same action block.๐๏ธ revokePushDeletes the pushenabled userSetting and unregisters the app from FCM (Google) and APNS (Apple).๐๏ธ routeDisplays a route in the default navigation app of the device. If an address exists, longitude and latitude will be ignored. If there is no address, both latitude and longitude is required.๐๏ธ saveImageLocallySaves an image to the local storage of the app.๐๏ธ sendFormMailOpens the device's default e-mail app 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. This primarly intended, for example, to display an onboarding or tutorial the first time the app is started, but to prevent another showing the next time the app is started.๐๏ธ 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 specified value to a form layer with the specified name (key).๐๏ธ setLocalReminderSets a reminder with the specified title and text to be displayed at the specified time.๐๏ธ setParamsSets values to the event parameters.๐๏ธ setTablePollingStateChanges the polling state of a database source to the duration of the specified name.๐๏ธ setTimeoutStarts a timer with the specified name to execute an action in the specified seconds from the time of start. Can be repeated with the same interval and keep running in the background.๐๏ธ setValueToUserSettingStores the provided value to a userSetting storage of the application.๐๏ธ setVariableStores the given value to a variable of the specified name.๐๏ธ shareUses the operating system's share functionality to share different data like text, photos, files or links.๐๏ธ showBarcodeScannerOpens a camera view with custom overlay for barcode reading functionality. Depending on the configuration, different options are available through the overlay's interface.๐๏ธ showDebugViewOpens the mos. applications included debug menu which displays various information and developer options.๐๏ธ 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 or actions reference each other so that the button with a specific index will trigger the corresponding event or action 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.
๐๏ธ closePopUpCloses the currently open pop-up on the view stack. If no pop-up is present, nothing happens.
๐๏ธ decryptSettingsWithBiometryDecrypts a value that was previously encrypted with personal biometric information. Uses the options available on the users device and operating system.
๐๏ธ deleteLocalImageDeletes a locally saved image with the specified name from the apps image folder on the device.
๐๏ธ deleteUserSettingDeletes the user setting with the specified name (key). This removes the key and its value.
๐๏ธ disableCrashlyticsDisables the collection of crash and similar data by Google Firebase Crashlytics.
๐๏ธ enableCrashlyticsEnables the collection of crash and similar data by Google Firebase Crashlytics.
๐๏ธ encryptSettingsWithBiometryEncrypts a value with personal biometric information. Uses the options available on the users device and operating system.
๐๏ธ 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.
๐๏ธ forEachA for each expression to loop through a list. Elements can be items of an array or keyed objects of a list.
๐๏ธ ifAn if expression to call different actions depending on whether the condition is met or not.
๐๏ธ importTableImports one or multiple tables to the app that have beed previously save as a JSON file using the exportTable action.
๐๏ธ insertFromParamsInserts data given via event parameters into the SQLite database of the application.
๐๏ธ insertFromRequestCombines the functionality of the request and insertFromParams actions into one, therefore requesting data which is then inserted into a database table of the application.
๐๏ธ logLogs a message with the desired log level. This message can then be used for debug purposes within the debug menu of the application.
๐๏ธ mailToOpens the device's default e-mail app and pre-fills the inputs with the provided data to send an e-mail.
๐๏ธ noActionCan be used to prevent a touch interaction to be propagated through the layers, e.g. to disable a button.
๐๏ธ openBrowserOpens 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.
๐๏ธ openWebSocketOpens a WebSocket connection to a service in order to receive messages from it and react to them.
๐๏ธ playNotificationSoundPlays the default notification sound set by the user within the operating system.
๐๏ธ preloadLoads data to be stored within the system storage of the app to ensure functionality or data access without a data connection. Ususally this includes files like media files (images, videos), PDFs or web content.
๐๏ธ ratingPrompts the user to rate the application using the system's native default rating overlay without leaving the app itself.
๐๏ธ registerPushRegisters the app with FCM (Android) or APNS (iOS) for push messages. A system prompt may appear for the user to confirm receiving notifications from this app before the actual registration concludes.
๐๏ธ reloadDatabaseTableRequest the data source of the specified database table manually and inserts the received data.
๐๏ธ requestPermissionRequests desired permissions to access guarded system resources like camera, position, etc. Depending on the operating system and version, this can result in a system prompt asking the user to accept or prevent this access.
๐๏ธ resetFormResets the form with the specified name. All form values of this form will be removed.
๐๏ธ revokePushDeletes the pushenabled userSetting and unregisters the app from FCM (Google) and APNS (Apple).
๐๏ธ routeDisplays a route in the default navigation app of the device. If an address exists, longitude and latitude will be ignored. If there is no address, both latitude and longitude is required.
๐๏ธ sendFormMailOpens the device's default e-mail app 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. This primarly intended, for example, to display an onboarding or tutorial the first time the app is started, but to prevent another showing the next time the app is started.
๐๏ธ setDataFromResultSets content to the given form from the form parameter or the current view's form.
๐๏ธ setLocalReminderSets a reminder with the specified title and text to be displayed at the specified time.
๐๏ธ setTablePollingStateChanges the polling state of a database source to the duration of the specified name.
๐๏ธ setTimeoutStarts a timer with the specified name to execute an action in the specified seconds from the time of start. Can be repeated with the same interval and keep running in the background.
๐๏ธ shareUses the operating system's share functionality to share different data like text, photos, files or links.
๐๏ธ showBarcodeScannerOpens a camera view with custom overlay for barcode reading functionality. Depending on the configuration, different options are available through the overlay's interface.
๐๏ธ showDebugViewOpens the mos. applications included debug menu which displays various information and developer options.
๐๏ธ validateFormValidates the fields of the specified form according to its defined validationExpression.