Actions
When an event is triggered (e.g. button is tapped), you can perform actions such as navigate to a screen, call an API, or even run JavaScript code.
Backend API interaction
| Property | Description |
|---|---|
| invokeAPI | invokeAPI is used for calling an API. You can call an API on events such as a button tap or on screen load. |
Navigation & UI transitions
| Property | Description |
|---|---|
| navigateScreen | navigateScreen action facilitates smooth navigation to a specific screen or page within the app's interface. |
| navigateModalScreen | navigateModalScreen action opens a specific screen or page as a modal overlay, focusing on the temporary view without losing the main app context. |
| navigateViewGroup | navigateViewGroup action allows users to navigate between menu items while maintaining the menu in place. This simulate the experience when user taps on different nav items. |
| navigateBack | navigateBack action allows users to go back to the previous screen or page within the app's navigation stack. |
| onViewGroupResume | onViewGroupResume action facilitates ensembleAction execution when navigating back to ViewGroup from different screen. |
| onViewGroupUpdate | onViewGroupUpdate action facilitates ensembleAction execution when update in ViewGroup occurs such as swithcing screen. |
| showDialog | showDialog action triggers the display of a modal dialog box within the app, presenting important information or notifications. |
| closeAllDialogs | closeAllDialogs action dismisses or closes all open modal dialogs within the app, ensuring a clutter-free interface. |
| showToast | showToast action displays a temporary notification or message on the app interface, providing concise and contextual updates to users. |
| uploadFiles | uploadFiles action allows users to select and upload files from their device to the app, facilitating data transfer and sharing. |
Device capabilities
| Property | Description |
|---|---|
| openCamera | openCamera action allows users to access their device's camera within the app for capturing images and videos. |
| getLocation | getLocation action retrieves the device's current location, enabling location-based functionalities within the app. |
| requestNotificationAccess | requestNotificationAccess action prompts users to grant permission for the app to send notifications to their device. |
| showNotification | showNotification action displays local notifications within the app, notifying users of important events or information. |
| notification | notification action manages and handles notifications within the app, enabling effective communication with users and delivering timely updates and alerts. |
| pickFiles | pickFiles action enables users to select files from their device for further processing or usage within the app. |
| uploadFiles | uploadFiles action allows users to select and upload files from their device to the app, facilitating data transfer and sharing. |
| getNetworkInfo | enables users to retrieve their device's current location, facilitating location-based functionalities within the app, such as mapping, navigation, or personalized content delivery, enhancing user experience and context-aware interactions. It requests user's permission to get his/her current location |
| saveFile | The saveFile action saves media files (e.g., images) to the default media storage and documents to the default documents directory on Android and IOS. On the web, it downloads the file to the browser's default download folder. |
Secure Storage
| Property | Description |
|---|---|
| setSecureStorage | setSecureStorage action securely stores sensitive information in an encrypted format on the device, ensuring that sensitive data remains protected. |
| getSecureStorage | getSecureStorage action retrieves previously stored encrypted data from the device's secure storage, decrypting it for use within your application. |
| clearSecureStorage | clearSecureStorage action removes previously stored encrypted data from the device's secure storage, allowing you to clean up sensitive information. |
| saveKeychain | saveKeychain action stores sensitive information in the device's secure keychain (iOS) and keyStore (Android). |
| readKeychain | readKeychain action retrieves previously stored data from the device's secure keychain (iOS) and keyStore (Android). |
| clearKeychain | clearKeychain action removes previously stored data from the device's secure keychain (iOS) and keyStore (Android). |
Other interactions
| Property | Description |
|---|---|
| executeCode | executeCode action executes custom code logic within the app, enabling dynamic functionality and personalized interactions. |
| openUrl | openUrl action opens external URLs or web links within the app, facilitating seamless integration with external content. |
| startTimer | startTimer action initiates a timer within the app, facilitating time-sensitive processes and triggering events after a specified duration. |
| openUrl | openUrl action allows users to open external URLs or web links within the app, enhancing content integration. |
| stopTimer | stopTimer action halts or pauses a running timer within the app, providing control over time-sensitive processes. |
| copyToClipboard | copyToClipboard action copies text or content to the device's clipboard, facilitating easy sharing and transfer of information within the app. |
3-rd party services
| Property | Description |
|---|---|
| connectWallet | connectWallet action establishes a connection between the app and the user's digital wallet, enabling blockchain-based interactions and transactions. |
| openPlaidLink | Open the Plaid Link Service so user can link their financial accounts to your service. |
Audio Player
| Property | Description |
|---|---|
| playAudio | The playAudio action allows users to play a given audio file from a URL or asset |
| pauseAudio | The pauseAudio action allows users to pause an already-playing audio file |
| resumeAudio | The resumeAudio action allows users to resume a previously paused audio |
| stopAudio | The stopAudio action allows users to stop a already playing audio file |
| seekAudio | The seekAudio action allows users to pause a already-playing audio file |