ActionsVersion: 4.53On 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: ๐๏ธaddCalendarAdds an event to the system calendar.๐๏ธaddContactAdds a contact to the user's contact book.๐๏ธaddDataSourceThe addDataSource action enables you to add a new database (or just its source) to you 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.๐๏ธalertTriggers an alert on the device, which may take the form of vibration, sound or a combination of both.๐๏ธaskUserShows a modal pop up with buttons. The list of buttons and events are referencing each other, so the button on index n will trigger the event on the same index.๐๏ธbackInHistoryNavigating back the view stack.๐๏ธbeginNFCReadingStarts listening to NFC tags.๐๏ธcalibrateAccelerometerCalibrates the accelerometer (acceleration sensor).๐๏ธcallCalls the indicated number.๐๏ธcancelTimeoutTerminates a previously set timeout.๐๏ธcheckBiometryChecks the user's biometric authentification.๐๏ธcheckForInactivityFires an event after a specified period of inactivity.๐๏ธcleanGeofencesCleans all existing geofences.๐๏ธclearCacheClears the cache of the app.๐๏ธclearCustomStartResets the start configuration for the app. The app will use the default configuration during the next launch.๐๏ธclearDatabaseResets the database.๐๏ธclearFormValueDeletes a value from a form (View data of specified form).๐๏ธ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.๐๏ธ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.๐๏ธ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.
๐๏ธaddDataSourceThe addDataSource action enables you to add a new database (or just its source) to you 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.
๐๏ธalertTriggers an alert on the device, which may take the form of vibration, sound or a combination of both.
๐๏ธaskUserShows a modal pop up with buttons. The list of buttons and events are referencing each other, so the button on index n will trigger the event on the same index.
๐๏ธclearCustomStartResets the start configuration for the app. The app will use the default configuration during the next launch.
๐๏ธexecuteQuerySQLExecutes an SQL query in the local database and makes the queried fields available in the parameters of the onSuccess action.
๐๏ธnoActionThis action can be used to block the user interaction from being propagting to the layer underneath or to ignore touch.