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.๐๏ธ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.
๐๏ธ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.
๐๏ธ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.